Table of Contents - apia-3.0.3 Documentation
Classes and Modules
- Apia
- Apia::API
- Apia::ArgumentSet
- Apia::ArgumentSet::MissingValue
- Apia::Authenticator
- Apia::CallableWithEnvironment
- Apia::Controller
- Apia::DSL
- Apia::DSLs
- Apia::DSLs::API
- Apia::DSLs::Argument
- Apia::DSLs::ArgumentSet
- Apia::DSLs::Authenticator
- Apia::DSLs::Concerns
- Apia::DSLs::Concerns::HasFields
- Apia::DSLs::Controller
- Apia::DSLs::Endpoint
- Apia::DSLs::Enum
- Apia::DSLs::Error
- Apia::DSLs::Field
- Apia::DSLs::LookupArgumentSet
- Apia::DSLs::Object
- Apia::DSLs::Polymorph
- Apia::DSLs::RouteGroup
- Apia::DSLs::RouteSet
- Apia::DSLs::Scalar
- Apia::DSLs::ScopeDescriptions
- Apia::DeepMerge
- Apia::Defineable
- Apia::Definition
- Apia::Definitions
- Apia::Definitions::API
- Apia::Definitions::Argument
- Apia::Definitions::ArgumentSet
- Apia::Definitions::Authenticator
- Apia::Definitions::Controller
- Apia::Definitions::Endpoint
- Apia::Definitions::Enum
- Apia::Definitions::Error
- Apia::Definitions::Field
- Apia::Definitions::LookupArgumentSet
- Apia::Definitions::Object
- Apia::Definitions::Polymorph
- Apia::Definitions::PolymorphOption
- Apia::Definitions::Scalar
- Apia::Definitions::Type
- Apia::Endpoint
- Apia::Enum
- Apia::EnvironmentErrorHandling
- Apia::Error
- Apia::ErrorExceptionError
- Apia::ErrorSet
- Apia::FieldSet
- Apia::FieldSpec
- Apia::FieldSpec::Parser
- Apia::FieldSpecParseError
- Apia::Helpers
- Apia::HookSet
- Apia::InvalidArgumentError
- Apia::InvalidEnumOptionError
- Apia::InvalidHelperError
- Apia::InvalidJSONError
- Apia::InvalidPolymorphValueError
- Apia::InvalidScalarValueError
- Apia::LookupArgumentSet
- Apia::LookupEnvironment
- Apia::ManifestError
- Apia::ManifestErrors
- Apia::ManifestErrors::Errors
- Apia::MissingArgumentError
- Apia::MockRequest
- Apia::NullFieldValueError
- Apia::Object
- Apia::ObjectSet
- Apia::PaginationObject
- Apia::ParseError
- Apia::Polymorph
- Apia::Rack
- Apia::RackError
- Apia::Request
- Apia::RequestEnvironment
- Apia::RequestHeaders
- Apia::Response
- Apia::Route
- Apia::RouteGroup
- Apia::RouteSet
- Apia::RuntimeError
- Apia::Scalar
- Apia::Scalars
- Apia::Scalars::Base64
- Apia::Scalars::Boolean
- Apia::Scalars::Date
- Apia::Scalars::Decimal
- Apia::Scalars::Integer
- Apia::Scalars::String
- Apia::Scalars::UnixTime
- Apia::Schema
- Apia::Schema::APIControllerSchemaType
- Apia::Schema::APISchemaType
- Apia::Schema::ArgumentSchemaType
- Apia::Schema::ArgumentSetSchemaType
- Apia::Schema::AuthenticatorSchemaType
- Apia::Schema::Controller
- Apia::Schema::ControllerEndpointSchemaType
- Apia::Schema::ControllerSchemaType
- Apia::Schema::EndpointSchemaType
- Apia::Schema::EnumSchemaType
- Apia::Schema::EnumValueSchemaType
- Apia::Schema::ErrorSchemaType
- Apia::Schema::FieldSchemaType
- Apia::Schema::FieldSpecOptionsSchemaType
- Apia::Schema::LookupArgumentSetSchemaType
- Apia::Schema::ObjectSchemaPolymorph
- Apia::Schema::ObjectSchemaType
- Apia::Schema::PolymorphOptionSchemaType
- Apia::Schema::PolymorphSchemaType
- Apia::Schema::RequestMethodEnum
- Apia::Schema::RouteGroupSchemaType
- Apia::Schema::RouteSchemaType
- Apia::Schema::RouteSetSchemaType
- Apia::Schema::ScalarSchemaType
- Apia::Schema::ScopeType
- Apia::ScopeNotGrantedError
- Apia::StandardError
Methods
- ::all — Apia::Scalars
- ::authorized_scope? — Apia::Authenticator
- ::camelize — Apia::Helpers
- ::cast — Apia::Enum
- ::cast — Apia::Scalar
- ::catch_errors — Apia::Endpoint
- ::class_name_to_id — Apia::Helpers
- ::collate_objects — Apia::ArgumentSet
- ::collate_objects — Apia::Authenticator
- ::collate_objects — Apia::Controller
- ::collate_objects — Apia::Endpoint
- ::collate_objects — Apia::Error
- ::collate_objects — Apia::LookupArgumentSet
- ::collate_objects — Apia::Object
- ::collate_objects — Apia::Polymorph
- ::create_from_request — Apia::ArgumentSet
- ::create_from_request — Apia::RequestHeaders
- ::definition — Apia::API
- ::definition — Apia::ArgumentSet
- ::definition — Apia::Authenticator
- ::definition — Apia::Controller
- ::definition — Apia::Endpoint
- ::definition — Apia::Enum
- ::definition — Apia::Error
- ::definition — Apia::LookupArgumentSet
- ::definition — Apia::Object
- ::definition — Apia::Polymorph
- ::definition — Apia::Scalar
- ::empty — Apia::Request
- ::error_triplet — Apia::Rack
- ::exception — Apia::Error
- ::execute — Apia::Authenticator
- ::execute — Apia::Endpoint
- ::fetch — Apia::Scalars
- ::include_field? — Apia::Endpoint
- ::json_triplet — Apia::Rack
- ::make_key — Apia::RequestHeaders
- ::merge — Apia::DeepMerge
- ::new — Apia::ArgumentSet
- ::new — Apia::Definition
- ::new — Apia::Definitions::Argument
- ::new — Apia::Definitions::Field
- ::new — Apia::Definitions::PolymorphOption
- ::new — Apia::Definitions::Type
- ::new — Apia::DSL
- ::new — Apia::DSLs::RouteGroup
- ::new — Apia::DSLs::RouteSet
- ::new — Apia::DSLs::ScopeDescriptions
- ::new — Apia::ErrorExceptionError
- ::new — Apia::InvalidArgumentError
- ::new — Apia::InvalidEnumOptionError
- ::new — Apia::InvalidPolymorphValueError
- ::new — Apia::InvalidScalarValueError
- ::new — Apia::ManifestError
- ::new — Apia::MissingArgumentError
- ::new — Apia::NullFieldValueError
- ::new — Apia::FieldSpec
- ::new — Apia::FieldSpec::Parser
- ::new — Apia::HookSet
- ::new — Apia::LookupEnvironment
- ::new — Apia::ManifestErrors
- ::new — Apia::ManifestErrors::Errors
- ::new — Apia::Object
- ::new — Apia::Rack
- ::new — Apia::RackError
- ::new — Apia::RequestEnvironment
- ::new — Apia::RequestHeaders
- ::new — Apia::Response
- ::new — Apia::Route
- ::new — Apia::RouteGroup
- ::new — Apia::RouteSet
- ::new — Apia::CallableWithEnvironment
- ::objects — Apia::API
- ::option_for_value — Apia::Polymorph
- ::parse — Apia::FieldSpec
- ::parse — Apia::Scalar
- ::register — Apia::Scalars
- ::schema — Apia::API
- ::singleton — Apia::ArgumentSet::MissingValue
- ::split_path — Apia::RouteSet
- ::strip_slashes — Apia::RouteSet
- ::test — Apia::Endpoint
- ::test_endpoint — Apia::API
- ::valid? — Apia::Scalar
- ::validate_all — Apia::API
- #[] — Apia::ArgumentSet
- #[] — Apia::RequestHeaders
- #[]= — Apia::RequestHeaders
- #action — Apia::DSLs::Authenticator
- #action — Apia::DSLs::Endpoint
- #add — Apia::DSLs::ScopeDescriptions
- #add — Apia::FieldSet
- #add — Apia::HookSet
- #add — Apia::ManifestErrors
- #add — Apia::ManifestErrors::Errors
- #add — Apia::RouteSet
- #add_cors_headers — Apia::Rack
- #add_field — Apia::Response
- #add_header — Apia::Response
- #add_last_word — Apia::FieldSpec::Parser
- #add_object — Apia::ObjectSet
- #api — Apia::Rack
- #argument — Apia::DSLs::ArgumentSet
- #argument — Apia::DSLs::Endpoint
- #argument_set — Apia::Definitions::Endpoint
- #argument_set? — Apia::Definitions::Type
- #arguments — Apia::Request
- #array — Apia::DSLs::Argument
- #array — Apia::DSLs::Field
- #array? — Apia::Definitions::Argument
- #array? — Apia::Definitions::Field
- #authenticator — Apia::DSLs::API
- #authenticator — Apia::DSLs::Controller
- #authenticator — Apia::DSLs::Endpoint
- #backend — Apia::DSLs::Field
- #body — Apia::Response
- #body? — Apia::Request
- #call — Apia::HookSet
- #call — Apia::LookupEnvironment
- #call — Apia::Rack
- #call — Apia::RequestEnvironment
- #call — Apia::CallableWithEnvironment
- #call_with_error_handling — Apia::CallableWithEnvironment
- #cast — Apia::Definitions::PolymorphOption
- #cast — Apia::Definitions::Type
- #cast — Apia::DSLs::Enum
- #cast — Apia::DSLs::Scalar
- #catch_exception — Apia::DSLs::Error
- #check_for_missing_required_arguments — Apia::ArgumentSet
- #code — Apia::DSLs::Error
- #condition — Apia::DSLs::Field
- #condition — Apia::DSLs::Object
- #controller — Apia::DSLs::RouteGroup
- #create — Apia::Defineable
- #default — Apia::DSLs::Argument
- #description — Apia::DSL
- #description — Apia::DSLs::RouteGroup
- #detail — Apia::ManifestError
- #development? — Apia::Rack
- #dig — Apia::ArgumentSet
- #dsl — Apia::Definitions::API
- #dsl — Apia::Definitions::Argument
- #dsl — Apia::Definitions::ArgumentSet
- #dsl — Apia::Definitions::Authenticator
- #dsl — Apia::Definitions::Controller
- #dsl — Apia::Definitions::Endpoint
- #dsl — Apia::Definitions::Enum
- #dsl — Apia::Definitions::Error
- #dsl — Apia::Definitions::Field
- #dsl — Apia::Definitions::LookupArgumentSet
- #dsl — Apia::Definitions::Object
- #dsl — Apia::Definitions::Polymorph
- #dsl — Apia::Definitions::Scalar
- #dsl — Apia::RouteSet
- #each — Apia::ManifestErrors::Errors
- #empty? — Apia::ManifestErrors
- #empty? — Apia::ManifestErrors::Errors
- #endpoint — Apia::DSLs::Controller
- #endpoint — Apia::Route
- #enum? — Apia::Definitions::Type
- #environment — Apia::LookupArgumentSet
- #error_for_exception — Apia::EnvironmentErrorHandling
- #errors — Apia::ManifestError
- #exception_handler — Apia::DSLs::API
- #extract_arguments — Apia::Route
- #fetch — Apia::RequestHeaders
- #field — Apia::DSLs::Endpoint
- #field — Apia::DSLs::Concerns::HasFields
- #find — Apia::RouteSet
- #find_error_by_name — Apia::EnvironmentErrorHandling
- #find_potential_error — Apia::EnvironmentErrorHandling
- #find_route — Apia::Rack
- #for — Apia::ManifestErrors
- #generate_hash — Apia::FieldSet
- #get_json_body_from_body — Apia::Request
- #get_json_body_from_params — Apia::Request
- #get_value_directly_from_object — Apia::Definitions::Field
- #get_value_from_backend — Apia::Definitions::Field
- #group — Apia::DSLs::RouteGroup
- #group — Apia::DSLs::RouteSet
- #handle_request — Apia::Rack
- #has? — Apia::ArgumentSet
- #hash — Apia::ErrorExceptionError
- #hash — Apia::FieldSpecParseError
- #hash — Apia::InvalidArgumentError
- #hash — Apia::InvalidJSONError
- #hash — Apia::MissingArgumentError
- #hash — Apia::NullFieldValueError
- #hash — Apia::RuntimeError
- #hash — Apia::Object
- #hash — Apia::Response
- #headers — Apia::Request
- #helper — Apia::DSLs::Controller
- #helper — Apia::RequestEnvironment
- #http_status — Apia::DSLs::Endpoint
- #http_status — Apia::DSLs::Error
- #http_status — Apia::ErrorExceptionError
- #http_status — Apia::FieldSpecParseError
- #http_status — Apia::InvalidArgumentError
- #http_status — Apia::InvalidJSONError
- #http_status — Apia::MissingArgumentError
- #http_status — Apia::NullFieldValueError
- #http_status — Apia::RuntimeError
- #http_status_code — Apia::Definitions::Endpoint
- #http_status_code — Apia::Definitions::Error
- #id — Apia::Definitions::Type
- #include? — Apia::Definitions::Field
- #include? — Apia::HookSet
- #include? — Apia::ManifestErrors::Errors
- #include? — Apia::Object
- #include_field? — Apia::FieldSpec
- #inspect — Apia::Defineable
- #ip — Apia::MockRequest
- #json_body — Apia::MockRequest
- #json_body — Apia::Request
- #klass — Apia::Definitions::Type
- #lookup_value — Apia::ArgumentSet
- #map — Apia::ManifestErrors::Errors
- #matches? — Apia::Definitions::PolymorphOption
- #method_missing — Apia::CallableWithEnvironment
- #method_missing — Apia::Defineable
- #name — Apia::DSL
- #name — Apia::DSLs::RouteGroup
- #name — Apia::Defineable
- #no_schema — Apia::DSL
- #no_schema — Apia::DSLs::RouteGroup
- #null — Apia::DSLs::Field
- #null? — Apia::Definitions::Field
- #object? — Apia::Definitions::Type
- #option — Apia::DSLs::Polymorph
- #paginate — Apia::RequestEnvironment
- #params — Apia::Request
- #parse — Apia::DSLs::Scalar
- #parse — Apia::FieldSpec::Parser
- #parse_json_from_string — Apia::Request
- #parse_value — Apia::ArgumentSet
- #path_parts — Apia::Route
- #path_string — Apia::InvalidArgumentError
- #path_string — Apia::MissingArgumentError
- #polymorph? — Apia::Definitions::Type
- #potential_error — Apia::DSLs::Authenticator
- #potential_error — Apia::DSLs::Endpoint
- #potential_error — Apia::DSLs::LookupArgumentSet
- #potential_error_sources — Apia::LookupEnvironment
- #potential_error_sources — Apia::RequestEnvironment
- #potential_errors — Apia::Definitions::Endpoint
- #potential_errors — Apia::Definitions::LookupArgumentSet
- #rack_triplet — Apia::Response
- #raise_error — Apia::EnvironmentErrorHandling
- #raise_exception — Apia::EnvironmentErrorHandling
- #raise_if_needed — Apia::ManifestErrors
- #raw_value_from_object — Apia::Definitions::Field
- #required — Apia::DSLs::Argument
- #required? — Apia::Definitions::Argument
- #resolve — Apia::LookupArgumentSet
- #resolver — Apia::DSLs::LookupArgumentSet
- #respond_to_missing? — Apia::CallableWithEnvironment
- #respond_to_missing? — Apia::Defineable
- #route — Apia::DSLs::RouteGroup
- #route — Apia::DSLs::RouteSet
- #routes — Apia::DSLs::API
- #scalar? — Apia::Definitions::Type
- #schema — Apia::DSLs::RouteSet
- #schema? — Apia::Definition
- #scope — Apia::DSLs::Endpoint
- #scope_validator — Apia::DSLs::Authenticator
- #scopes — Apia::DSLs::API
- #scopes — Apia::DSLs::Endpoint
- #setup — Apia::Definition
- #setup — Apia::Definitions::API
- #setup — Apia::Definitions::ArgumentSet
- #setup — Apia::Definitions::Authenticator
- #setup — Apia::Definitions::Controller
- #setup — Apia::Definitions::Endpoint
- #setup — Apia::Definitions::Enum
- #setup — Apia::Definitions::Error
- #setup — Apia::Definitions::Object
- #setup — Apia::Definitions::Polymorph
- #size — Apia::HookSet
- #spec — Apia::FieldSet
- #to_hash — Apia::ArgumentSet
- #to_s — Apia::InvalidArgumentError
- #to_s — Apia::InvalidEnumOptionError
- #to_s — Apia::InvalidPolymorphValueError
- #to_s — Apia::InvalidScalarValueError
- #to_s — Apia::ManifestError
- #to_s — Apia::NullFieldValueError
- #triplet — Apia::ManifestError
- #triplet — Apia::RackError
- #triplet_for_exception — Apia::Rack
- #type — Apia::Definitions::Argument
- #type — Apia::Definitions::Field
- #type — Apia::Definitions::PolymorphOption
- #type — Apia::DSLs::Authenticator
- #usable_for_argument? — Apia::Definitions::Type
- #usable_for_field? — Apia::Definitions::Type
- #validate — Apia::ArgumentSet
- #validate — Apia::Definition
- #validate — Apia::Definitions::API
- #validate — Apia::Definitions::Argument
- #validate — Apia::Definitions::ArgumentSet
- #validate — Apia::Definitions::Authenticator
- #validate — Apia::Definitions::Controller
- #validate — Apia::Definitions::Endpoint
- #validate — Apia::Definitions::Enum
- #validate — Apia::Definitions::Error
- #validate — Apia::Definitions::LookupArgumentSet
- #validate — Apia::Definitions::Object
- #validate — Apia::Definitions::Polymorph
- #validate — Apia::Definitions::PolymorphOption
- #validate — Apia::Definitions::Scalar
- #validate — Apia::ErrorSet
- #validate — Apia::FieldSet
- #validate — Apia::LookupArgumentSet
- #validate_api — Apia::Rack
- #validate_value — Apia::Definitions::Argument
- #validation — Apia::DSLs::Argument
- #validator — Apia::DSLs::Scalar
- #value — Apia::Definitions::Field
- #value — Apia::DSLs::Enum
- #value_from_route — Apia::ArgumentSet