Skip to content

oapi.errors

OAPIError

Bases: Exception

This is base class for oapi errors.

OAPIReferenceError

Bases: oapi.errors.OAPIError, ValueError

This is base class for errors encountered while attempting to resolve references in an OpenAPI document.

OAPIReferenceLoopError

Bases: oapi.errors.OAPIReferenceError

This is an error raised when a referential loop is encountered. This error will only be encountered if attempting to recursively dereference a document using oapi.oas.references.Resolver.dereference. Typical usage of oapi does not require dereferencing a document.

OAPIReferencePointerError

Bases: oapi.errors.OAPIReferenceError

This is an error raised when a reference has a pointer which cannot be resolved (no entity exists at the indicated position).

OAPIDuplicateClassNameError

Bases: oapi.errors.OAPIError

This is an error raised if/when an instance of oapi.ModelModule produces two model classes having the same name. This is not possible using the default naming algorithm, however a custom class naming callback function can be provided, so this scenario is possible in that case.