OpenAPI Reference
=================


Objects
-------

Main OpenAPI object:

.. autoclass:: dmr.openapi.openapi.OpenAPI
   :members:

Parts:

.. autoclass:: dmr.openapi.objects.Callback
   :members:

.. autoclass:: dmr.openapi.objects.Components
   :members:

.. autoclass:: dmr.openapi.objects.Contact
   :members:

.. autoclass:: dmr.openapi.objects.Discriminator
   :members:

.. autoclass:: dmr.openapi.objects.Encoding
   :members:

.. autoclass:: dmr.openapi.objects.Example
   :members:

.. autoclass:: dmr.openapi.objects.ExternalDocumentation
   :members:

.. autoclass:: dmr.openapi.objects.Header
   :members:

.. autoclass:: dmr.openapi.objects.Info
   :members:

.. autoclass:: dmr.openapi.objects.License
   :members:

.. autoclass:: dmr.openapi.objects.Link
   :members:

.. autoclass:: dmr.openapi.objects.MediaTypeMetadata
   :members:

.. autoclass:: dmr.openapi.objects.MediaType
   :members:

.. autoclass:: dmr.openapi.objects.OAuthFlow
   :members:

.. autoclass:: dmr.openapi.objects.OAuthFlows
   :members:

.. autoclass:: dmr.openapi.objects.OpenAPIFormat
   :members:

.. autoclass:: dmr.openapi.objects.OpenAPIType
   :members:

.. autoclass:: dmr.openapi.objects.Operation
   :members:

.. autoclass:: dmr.openapi.objects.ParameterMetadata
  :members:

.. autoclass:: dmr.openapi.objects.Parameter
   :inherited-members:
   :show-inheritance:
   :members:

.. autoclass:: dmr.openapi.objects.PathItem
   :members:

.. autoclass:: dmr.openapi.objects.Paths
   :members:

.. autoclass:: dmr.openapi.objects.Reference
   :members:

.. autoclass:: dmr.openapi.objects.RequestBody
   :members:

.. autoclass:: dmr.openapi.objects.Response
   :members:

.. autoclass:: dmr.openapi.objects.Responses
   :members:

.. autoclass:: dmr.openapi.objects.Schema
   :members:

.. autoclass:: dmr.openapi.objects.SecurityRequirement
   :members:

.. autoclass:: dmr.openapi.objects.SecurityScheme
   :members:

.. autoclass:: dmr.openapi.objects.Server
   :members:

.. autoclass:: dmr.openapi.objects.ServerVariable
   :members:

.. autoclass:: dmr.openapi.objects.Tag
   :members:

.. autoclass:: dmr.openapi.objects.XML
   :members:


Core
----

.. autoclass:: dmr.openapi.core.merger.ConfigMerger
   :members:

.. autoclass:: dmr.openapi.core.registry.OperationIdRegistry
   :members:

.. autoclass:: dmr.openapi.core.registry.SchemaRegistry
   :members:

.. autoclass:: dmr.openapi.core.registry.SchemaCallback
  :members:


Generators
----------

.. autoclass:: dmr.openapi.generators.ComponentParserGenerator
   :members:

.. autoclass:: dmr.openapi.generators.ResponseGenerator
   :members:

.. autoclass:: dmr.openapi.generators.SchemaGenerator
   :members:

.. autoclass:: dmr.openapi.generators.SecuritySchemeGenerator
   :members:

.. autoclass:: dmr.openapi.generators.OperationIdGenerator
   :members:


Existing views
--------------

.. autoclass:: dmr.openapi.views.ScalarView
  :members:

.. autoclass:: dmr.openapi.views.SwaggerView
  :members:

.. autoclass:: dmr.openapi.views.RedocView
  :members:

.. autoclass:: dmr.openapi.views.StoplightView
  :members:

.. autoclass:: dmr.openapi.views.OpenAPIJsonView
  :members:

.. autoclass:: dmr.openapi.views.yaml.OpenAPIYamlView
  :members:
