github/tornado-openapi3
1
0
Fork 0
mirror of https://github.com/correl/tornado-openapi3.git synced 2024-12-27 11:09:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Reformat request handler docstring

Browse source
This commit is contained in:
Correl Roush 2021-03-17 16:16:04 -04:00
parent 72cead3683
commit 98cbaec514
1 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
tornado_openapi3/handler.py
View file

@ -79,31 +79,31 @@ class OpenAPIRequestHandler(tornado.web.RequestHandler):
encountered while validating the request are translated to HTTP error
codes:
+-----------------------------+----------+----------------------------------------+
|OpenAPI Errors |Error Code|Description |
+-----------------------------+----------+----------------------------------------+
|``PathNotFound`` |``404`` |Could not find the path for this request|
| | |in the OpenAPI specification. |
+-----------------------------+----------+----------------------------------------+
|``OperationNotFound`` |``405`` |Could not find the operation specified |
| | |for this request in the OpenAPI |
| | |specification. |
+-----------------------------+----------+----------------------------------------+
|``CastError``, |``400`` |The message body could not be decoded or|
|``DeserializeError``, | |did not validate against the specified |
|``MissingRequiredParameter``,| |schema. |
|``MissingRequestBody``, | | |
|``ValidateError`` | | |
+-----------------------------+----------+----------------------------------------+
|``InvalidSecurity`` |``401`` |Required authorization was missing from |
| | |the request. |
+-----------------------------+----------+----------------------------------------+
|``InvalidContentType`` |``415`` |The content type of the request did not |
| | |match any of the types in the OpenAPI |
| | |specification. |
+-----------------------------+----------+----------------------------------------+
|Any other ``OpenAPIError`` |``500`` |An unexpected error occurred. |
+-----------------------------+----------+----------------------------------------+
+-----------------------------+----------+-------------------------------------+
|OpenAPI Errors |Error Code|Description |
+-----------------------------+----------+-------------------------------------+
|``PathNotFound`` |``404`` |Could not find the path for this |
| | |request in the OpenAPI specification.|
+-----------------------------+----------+-------------------------------------+
|``OperationNotFound`` |``405`` |Could not find the operation |
| | |specified for this request in the |
| | |OpenAPI specification. |
+-----------------------------+----------+-------------------------------------+
|``CastError``, |``400`` |The message body could not be decoded|
|``DeserializeError``, | |or did not validate against the |
|``MissingRequiredParameter``,| |specified schema. |
|``MissingRequestBody``, | | |
|``ValidateError`` | | |
+-----------------------------+----------+-------------------------------------+
|``InvalidSecurity`` |``401`` |Required authorization was missing |
| | |from the request. |
+-----------------------------+----------+-------------------------------------+
|``InvalidContentType`` |``415`` |The content type of the request did |
| | |not match any of the types in the |
| | |OpenAPI specification. |
+-----------------------------+----------+-------------------------------------+
|Any other ``OpenAPIError`` |``500`` |An unexpected error occurred. |
+-----------------------------+----------+-------------------------------------+
To provide content in these error requests, you may override
:meth:`on_openapi_error`.