Skip to content

Commit

Permalink
doc - exceptions
Browse files Browse the repository at this point in the history
  • Loading branch information
commonism committed Aug 10, 2023
1 parent fd18a6a commit 4312abb
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,14 @@ Parameters are part of the operation specification and can be in

.. autoclass:: aiopenapi3.v20.parameter.Parameter
:members:
:undoc-members: model_config, model_fields
:exclude-members: model_config, model_fields
:undoc-members:
:noindex:

.. autoclass:: aiopenapi3.v30.parameter.Parameter
:members:
:undoc-members: model_config, model_fields
:exclude-members: model_config, model_fields
:undoc-members:
:noindex:

Parameter Encoding
Expand All @@ -64,12 +66,16 @@ Additionally Swagger 2.0 has a different encoding strategy to OpenAPI 3.x.

.. autoclass:: aiopenapi3.v20.parameter._ParameterCodec
:members:
:undoc-members: SEPERATOR_VALUES
:exclude-members: SEPERATOR_VALUES
:undoc-members:
:private-members:
:noindex:

.. autoclass:: aiopenapi3.v30.parameter._ParameterCodec
:members:

:undoc-members:
:private-members:
:noindex:

Plugin Interface
================
Expand Down Expand Up @@ -189,17 +195,7 @@ of the document, and loaded relative to the basedir of the RedirectLoader.
Exceptions
==========

.. inheritance-diagram:: aiopenapi3.errors.SpecError \
aiopenapi3.errors.ReferenceResolutionError \
aiopenapi3.errors.OperationParameterValidationError \
aiopenapi3.errors.ParameterFormatError \
aiopenapi3.errors.HTTPError \
aiopenapi3.errors.RequestError \
aiopenapi3.errors.ResponseError \
aiopenapi3.errors.ContentTypeError \
aiopenapi3.errors.HTTPStatusError \
aiopenapi3.errors.ResponseDecodingError \
aiopenapi3.errors.ResponseSchemaError
.. inheritance-diagram:: aiopenapi3.errors.SpecError aiopenapi3.errors.ReferenceResolutionError aiopenapi3.errors.OperationParameterValidationError aiopenapi3.errors.ParameterFormatError aiopenapi3.errors.HTTPError aiopenapi3.errors.RequestError aiopenapi3.errors.ResponseError aiopenapi3.errors.ContentTypeError aiopenapi3.errors.HTTPStatusError aiopenapi3.errors.ResponseDecodingError aiopenapi3.errors.ResponseSchemaError
:top-classes: aiopenapi3.errors.BaseError
:parts: -1

Expand Down

0 comments on commit 4312abb

Please sign in to comment.