Module: Gitlab::GrapeOpenapi

Defined in:
lib/gitlab-grape-openapi.rb,
lib/gitlab/grape_openapi/version.rb,
lib/gitlab/grape_openapi/generator.rb,
lib/gitlab/grape_openapi/models/tag.rb,
lib/gitlab/grape_openapi/models/info.rb,
lib/gitlab/grape_openapi/tag_registry.rb,
lib/gitlab/grape_openapi/configuration.rb,
lib/gitlab/grape_openapi/models/schema.rb,
lib/gitlab/grape_openapi/models/server.rb,
lib/gitlab/grape_openapi/models/response.rb,
lib/gitlab/grape_openapi/schema_registry.rb,
lib/gitlab/grape_openapi/models/operation.rb,
lib/gitlab/grape_openapi/models/parameter.rb,
lib/gitlab/grape_openapi/models/path_item.rb,
lib/gitlab/grape_openapi/serializers/time.rb,
lib/gitlab/grape_openapi/concerns/serializable.rb,
lib/gitlab/grape_openapi/request_body_registry.rb,
lib/gitlab/grape_openapi/models/security_scheme.rb,
lib/gitlab/grape_openapi/models/server_variable.rb,
lib/gitlab/grape_openapi/concerns/limit_resolver.rb,
lib/gitlab/grape_openapi/concerns/regex_converter.rb,
lib/gitlab/grape_openapi/converters/tag_converter.rb,
lib/gitlab/grape_openapi/converters/type_resolver.rb,
lib/gitlab/grape_openapi/converters/path_converter.rb,
lib/gitlab/grape_openapi/converters/coercer_resolver.rb,
lib/gitlab/grape_openapi/converters/entity_converter.rb,
lib/gitlab/grape_openapi/converters/response_converter.rb,
lib/gitlab/grape_openapi/concerns/fail_fast_annotatable.rb,
lib/gitlab/grape_openapi/converters/operation_converter.rb,
lib/gitlab/grape_openapi/converters/parameter_converter.rb,
lib/gitlab/grape_openapi/models/request_body/parameters.rb,
lib/gitlab/grape_openapi/converters/request_body_converter.rb,
lib/gitlab/grape_openapi/models/request_body/parameter_schema.rb

Defined Under Namespace

Modules: Concerns, Converters, Models, Serializers Classes: Configuration, Generator, RequestBodyRegistry, SchemaRegistry, TagRegistry

Constant Summary collapse

GenerationError =
Class.new(StandardError)
VERSION =

Version of the gem

"0.1.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configurationObject



51
52
53
# File 'lib/gitlab-grape-openapi.rb', line 51

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Yields:



55
56
57
# File 'lib/gitlab-grape-openapi.rb', line 55

def configure
  yield(configuration)
end

.generate(options = {}) ⇒ Object



59
60
61
# File 'lib/gitlab-grape-openapi.rb', line 59

def generate(options = {})
  Generator.new(options).generate
end