View Source argo_graphql_service_document (argo v1.0.8)

Summary

Types

-type t() ::
    #argo_graphql_service_document{description :: none | {some, unicode:unicode_binary()},
                                   directives :: argo_graphql_directives_const:t(),
                                   schema_defined :: boolean(),
                                   query :: none | {some, argo_types:name()},
                                   mutation :: none | {some, argo_types:name()},
                                   subscription :: none | {some, argo_types:name()},
                                   directive_definitions ::
                                       #{argo_types:name() =>
                                             argo_graphql_directive_definition:t()},
                                   type_definitions ::
                                       #{argo_types:name() => argo_graphql_type_definition:t()}}.

Functions

Link to this function

add_directive_const(ServiceDocument, DirectiveConst)

View Source
-spec add_directive_const(ServiceDocument, DirectiveConst) -> ServiceDocument
                       when
                           ServiceDocument :: t(),
                           DirectiveConst :: argo_graphql_directive_const:t().
Link to this function

add_directive_definition(ServiceDocument, DirectiveDefinition)

View Source
-spec add_directive_definition(ServiceDocument, DirectiveDefinition) -> ServiceDocument
                            when
                                ServiceDocument :: t(),
                                DirectiveDefinition :: argo_graphql_directive_definition:t().
Link to this function

add_language_definition(ServiceDocument, LanguageDefinition)

View Source
-spec add_language_definition(ServiceDocument, LanguageDefinition) -> ServiceDocument
                           when
                               ServiceDocument :: t(),
                               LanguageDefinition :: argo_graphql_language_definition:t().
Link to this function

add_language_schema_definition(ServiceDocument, LanguageSchemaDefinition)

View Source
-spec add_language_schema_definition(ServiceDocument, LanguageSchemaDefinition) -> ServiceDocument
                                  when
                                      ServiceDocument :: t(),
                                      LanguageSchemaDefinition ::
                                          argo_graphql_language_schema_definition:t().
Link to this function

add_language_schema_extension(ServiceDocument, LanguageSchemaExtension)

View Source
-spec add_language_schema_extension(ServiceDocument, LanguageSchemaExtension) -> ServiceDocument
                                 when
                                     ServiceDocument :: t(),
                                     LanguageSchemaExtension ::
                                         argo_graphql_language_schema_extension:t().
Link to this function

add_language_type_extension(ServiceDocument, LanguageTypeExtension)

View Source
-spec add_language_type_extension(ServiceDocument, LanguageTypeExtension) -> ServiceDocument
                               when
                                   ServiceDocument :: t(),
                                   LanguageTypeExtension ::
                                       argo_graphql_language_type_extension:t().
Link to this function

add_root_operation_type_definition(ServiceDocument, OperationType, NamedType)

View Source
-spec add_root_operation_type_definition(ServiceDocument, OperationType, NamedType) -> ServiceDocument
                                      when
                                          ServiceDocument :: t(),
                                          OperationType :: operation_type(),
                                          NamedType :: argo_types:name().
Link to this function

add_type_definition(ServiceDocument, TypeDefinition)

View Source
-spec add_type_definition(ServiceDocument, TypeDefinition) -> ServiceDocument
                       when
                           ServiceDocument :: t(),
                           TypeDefinition :: argo_graphql_type_definition:t().
Link to this function

find_directive_definition(ServiceDocument, DirectiveName)

View Source
-spec find_directive_definition(ServiceDocument, DirectiveName) -> {ok, DirectiveDefinition} | error
                             when
                                 ServiceDocument :: t(),
                                 DirectiveName :: argo_types:name(),
                                 DirectiveDefinition :: argo_graphql_directive_definition:t().
Link to this function

find_type_definition(ServiceDocument, TypeName)

View Source
-spec find_type_definition(ServiceDocument, TypeName) -> {ok, TypeDefinition} | error
                        when
                            ServiceDocument :: t(),
                            TypeName :: argo_types:name(),
                            TypeDefinition :: argo_graphql_type_definition:t().
Link to this function

format(Formatter1, Type)

View Source
-spec format(Formatter1, Type :: t()) -> Formatter2
          when Formatter1 :: argo_graphql_formatter:t(), Formatter2 :: argo_graphql_formatter:t().
-spec format_error(dynamic(), dynamic()) -> dynamic().
-spec from_file(Filename) -> ServiceDocument
             when Filename :: file:filename_all(), ServiceDocument :: t().
Link to this function

from_language(LanguageDocument)

View Source
-spec from_language(LanguageDocument) -> ServiceDocument
                 when
                     LanguageDocument :: argo_graphql_language_document:t(),
                     ServiceDocument :: t().
-spec from_string(Input) -> ServiceDocument when Input :: unicode:chardata(), ServiceDocument :: t().
Link to this function

get_directive_definition(ServiceDocument, DirectiveName)

View Source
-spec get_directive_definition(ServiceDocument, DirectiveName) -> DirectiveDefinition
                            when
                                ServiceDocument :: t(),
                                DirectiveName :: argo_types:name(),
                                DirectiveDefinition :: argo_graphql_directive_definition:t().
Link to this function

get_input_type_definition(ServiceDocument, InputTypeName)

View Source
-spec get_input_type_definition(ServiceDocument, InputTypeName) -> InputTypeDefinition
                             when
                                 ServiceDocument :: t(),
                                 InputTypeName :: argo_types:name(),
                                 InputTypeDefinition :: argo_graphql_type_definition:t().
Link to this function

get_input_type_graph(ServiceDocument)

View Source
-spec get_input_type_graph(ServiceDocument) -> InputTypeGraph
                        when
                            ServiceDocument :: t(),
                            InputTypeGraph :: argo_graphql_input_type_graph:t().
Link to this function

get_input_type_graph(ServiceDocument, InputTypeName)

View Source
-spec get_input_type_graph(ServiceDocument, InputTypeName) -> InputTypeGraph
                        when
                            ServiceDocument :: t(),
                            InputTypeName :: argo_types:name(),
                            InputTypeGraph :: argo_graphql_input_type_graph:t().
Link to this function

get_interface_type_definition(ServiceDocument, InterfaceName)

View Source
-spec get_interface_type_definition(ServiceDocument, InterfaceName) -> InterfaceTypeDefinition
                                 when
                                     ServiceDocument :: t(),
                                     InterfaceName :: argo_types:name(),
                                     InterfaceTypeDefinition :: argo_graphql_type_definition:t().
Link to this function

get_root_operation_type_definition(ServiceDocument, RootOperationType)

View Source
-spec get_root_operation_type_definition(ServiceDocument, RootOperationType) ->
                                      RootOperationTypeDefinition
                                      when
                                          ServiceDocument :: t(),
                                          RootOperationType :: operation_type(),
                                          RootOperationTypeDefinition ::
                                              argo_graphql_type_definition:t().
Link to this function

get_shape(ServiceDocument, TypeName)

View Source
-spec get_shape(ServiceDocument, TypeName) -> Shape
             when
                 ServiceDocument :: t(),
                 TypeName :: argo_types:name(),
                 Shape :: argo_graphql_type_definition:shape().
Link to this function

get_type_definition(ServiceDocument, TypeName)

View Source
-spec get_type_definition(ServiceDocument, TypeName) -> TypeDefinition
                       when
                           ServiceDocument :: t(),
                           TypeName :: argo_types:name(),
                           TypeDefinition :: argo_graphql_type_definition:t().
Link to this function

get_union_member_type_definition(ServiceDocument, UnionMemberType)

View Source
-spec get_union_member_type_definition(ServiceDocument, UnionMemberType) -> UnionMemberTypeDefinition
                                    when
                                        ServiceDocument :: t(),
                                        UnionMemberType :: argo_types:name(),
                                        UnionMemberTypeDefinition ::
                                            argo_graphql_type_definition:t().
-spec new() -> ServiceDocument when ServiceDocument :: t().
Link to this function

replace_type_definition(ServiceDocument, TypeDefinition)

View Source
-spec replace_type_definition(ServiceDocument, TypeDefinition) -> ServiceDocument
                           when
                               ServiceDocument :: t(),
                               TypeDefinition :: argo_graphql_type_definition:t().
Link to this function

resolve_type_definitions(ServiceDocument)

View Source
-spec resolve_type_definitions(ServiceDocument) -> ServiceDocument when ServiceDocument :: t().
Link to this function

set_description(ServiceDocument, OptionDescription)

View Source
-spec set_description(ServiceDocument, OptionDescription) -> ServiceDocument
                   when
                       ServiceDocument :: t(),
                       OptionDescription :: none | {some, unicode:unicode_binary()}.