class Analyzer::Specification::PayloadCms

Overview

Payload CMS mounts every collection at /api/<slug> and every global at /api/globals/<slug>, generating the CRUD verbs plus auth and version route families from flags on the config.

Included Modules

Defined in:

analyzer/analyzers/specification/payload_cms.cr

Constant Summary

DEFAULT_API_PREFIX = "/api"
FIELD_TYPE_HINTS = {"text" => "string", "textarea" => "string", "email" => "string", "code" => "string", "richtext" => "string", "select" => "string", "radio" => "string", "relationship" => "string", "upload" => "string", "number" => "number", "checkbox" => "boolean", "date" => "datetime", "json" => "object", "group" => "object", "point" => "array", "array" => "array", "blocks" => "array"}
MAX_FIELD_DEPTH = 2

Matches graphql_sdl_parser's nesting cap.

MAX_FILTER_PARAMS = 25
NESTING_TYPES = {"group", "array", "blocks"}

These do carry a name and nest their children under it.

PRESENTATIONAL_TYPES = {"row", "collapsible", "ui"}

Layout-only field types carry no name; their children belong to the parent document. Most real configs wrap fields in these, so hoisting is what makes the body params correct.

TAG_SOURCE = "payload_cms_analyzer"

Class Method Summary

Instance Method Summary

Instance methods inherited from module Analyzer::Specification::SchemaApiCommon

api_mount_join(prefix : String, path : String) : String api_mount_join, emit(sink : Array(Endpoint), url : String, method : String, params : Array(Param), details : Details, tag_name : String, tag_value : String, tag_source : String) : Endpoint emit, normalize_colon_path(path : String) : String normalize_colon_path, push_param_once(params : Array(Param), param : Param) : Nil push_param_once, type_hint(raw : String, table : Hash(String, String)) : String type_hint

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]