class Analyzer::Specification::Hasura

Overview

Hasura does not generate per-table REST routes. A tracked table becomes a set of GraphQL root fields on POST /v1/graphql; the only REST surface is whatever metadata/rest_endpoints.yaml declares. Emitting /api/rest/<table> would invent endpoints that 404.

Rather than re-deriving GraphQL handling, each tracked table is rendered as a small SDL document and handed to GraphqlSdlParser. That yields the fragment URL convention (/v1/graphql#Query.movies), a runnable operation document per field, and input-object expansion into dotted params — all of which the SDL analyzer already does.

Included Modules

Defined in:

analyzer/analyzers/specification/hasura.cr

Constant Summary

GRAPHQL_IDENTIFIER = /\A[A-Za-z_][A-Za-z0-9_]*\z/

Column names must be valid GraphQL identifiers to appear in the synthesized SDL.

GRAPHQL_PATH = "/v1/graphql"
PERMISSION_KEYS = {"select_permissions", "insert_permissions", "update_permissions", "delete_permissions"}

Hasura's metadata carries no column list of its own; column-level permissions are the only place columns are named.

REST_PREFIX = "/api/rest"
TAG_SOURCE = "hasura_analyzer"

Instance Method Summary

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

emit(sink : Array(Endpoint), url : String, method : String, params : Array(Param), details : Details, tag_name : String, tag_value : String, tag_source : String) : Endpoint emit, join_path(prefix : String, path : String) : String join_path, 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, callees_needed? : Bool callees_needed?, 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, 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

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, 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_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

Instance Method Detail

def analyze #

[View source]