Module: Brainstem::ApiDocs

Includes:

ActiveSupport::Configurable

Defined in:

lib/brainstem/api_docs.rb,
lib/brainstem/api_docs/atlas.rb,
lib/brainstem/api_docs/builder.rb,
lib/brainstem/api_docs/endpoint.rb,
lib/brainstem/api_docs/resolver.rb,
lib/brainstem/api_docs/presenter.rb,
lib/brainstem/api_docs/controller.rb,
lib/brainstem/api_docs/exceptions.rb,
lib/brainstem/api_docs/sinks/stdout_sink.rb,
lib/brainstem/api_docs/abstract_collection.rb,
lib/brainstem/api_docs/endpoint_collection.rb,
lib/brainstem/api_docs/sinks/abstract_sink.rb,
lib/brainstem/api_docs/presenter_collection.rb,
lib/brainstem/api_docs/controller_collection.rb,
lib/brainstem/api_docs/formatters/markdown/helper.rb,
lib/brainstem/api_docs/formatters/abstract_formatter.rb,
lib/brainstem/api_docs/introspectors/rails_introspector.rb,
lib/brainstem/api_docs/sinks/open_api_specification_sink.rb,
lib/brainstem/api_docs/introspectors/abstract_introspector.rb,
lib/brainstem/api_docs/formatters/markdown/endpoint_formatter.rb,
lib/brainstem/api_docs/formatters/markdown/presenter_formatter.rb,
lib/brainstem/api_docs/formatters/markdown/controller_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/helper.rb,
lib/brainstem/api_docs/sinks/controller_presenter_multifile_sink.rb,
lib/brainstem/api_docs/formatters/markdown/endpoint_collection_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/tags_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/presenter_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/controller_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_collection_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/security_definitions_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/param_definitions_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/response_definitions_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/endpoint_param_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/response_field_formatter.rb,
lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/presenter_field_formatter.rb

Defined Under Namespace

Modules: Formatters, Introspectors, Sinks Classes: AbstractCollection, Atlas, Builder, Controller, ControllerCollection, Endpoint, EndpointCollection, IncorrectIntrospectorForAppException, InvalidAtlasError, InvalidIntrospectorError, NoSinkSpecifiedException, Presenter, PresenterCollection, Resolver

Constant Summary

FORMATTERS =

{

  # Formatter for entire response
  document: {},

  # Formatters for collections
  controller_collection: {},
  endpoint_collection:   {},
  presenter_collection:  {},

  # Formatters for individual entities
  controller: {},
  endpoint:   {},
  presenter:  {},

  # Formatter for Open API Specifications
  info:       {},
  response:   {},
  parameters: {},
  security:   {},
  tags:       {},

  # Formatter for Open API Specifications Individual field / param definition
  endpoint_param:  {},
  presenter_field: {},
  response_field:  {},
}