|
OpenQuizz
Une application de gestion des contenus pédagogiques
|


Public Member Functions | |
| def | __init__ (self, api) |
| def | as_dict (self) |
| def | get_host (self) |
| def | extract_tags (self, api) |
| def | extract_resource_doc (self, resource, url, route_doc=None) |
| def | expected_params (self, doc) |
| def | register_errors (self) |
| def | serialize_resource (self, ns, resource, url, route_doc=None, **kwargs) |
| def | serialize_operation (self, doc, method) |
| def | vendor_fields (self, doc, method) |
| def | description_for (self, doc, method) |
| def | operation_id_for (self, doc, method) |
| def | parameters_for (self, doc) |
| def | responses_for (self, doc, method) |
| def | process_headers (self, response, doc, method=None, headers=None) |
| def | serialize_definitions (self) |
| def | serialize_schema (self, model) |
| def | register_model (self, model) |
| def | register_field (self, field) |
| def | security_for (self, doc, method) |
| def | security_requirements (self, value) |
| def | security_requirement (self, value) |
Data Fields | |
| api | |
A Swagger documentation wrapper for an API instance.
| def __init__ | ( | self, | |
| api | |||
| ) |
| def as_dict | ( | self | ) |
Output the specification as a serializable ``dict``. :returns: the full Swagger specification in a serializable format :rtype: dict
| def description_for | ( | self, | |
| doc, | |||
| method | |||
| ) |
Extract the description metadata and fallback on the whole docstring
| def expected_params | ( | self, | |
| doc | |||
| ) |
| def extract_resource_doc | ( | self, | |
| resource, | |||
| url, | |||
route_doc = None |
|||
| ) |
| def extract_tags | ( | self, | |
| api | |||
| ) |
| def get_host | ( | self | ) |
| def operation_id_for | ( | self, | |
| doc, | |||
| method | |||
| ) |
Extract the operation id
| def parameters_for | ( | self, | |
| doc | |||
| ) |
| def process_headers | ( | self, | |
| response, | |||
| doc, | |||
method = None, |
|||
headers = None |
|||
| ) |
| def register_errors | ( | self | ) |
| def register_field | ( | self, | |
| field | |||
| ) |
| def register_model | ( | self, | |
| model | |||
| ) |
| def responses_for | ( | self, | |
| doc, | |||
| method | |||
| ) |
| def security_for | ( | self, | |
| doc, | |||
| method | |||
| ) |
| def security_requirement | ( | self, | |
| value | |||
| ) |
| def security_requirements | ( | self, | |
| value | |||
| ) |
| def serialize_definitions | ( | self | ) |
| def serialize_operation | ( | self, | |
| doc, | |||
| method | |||
| ) |
| def serialize_resource | ( | self, | |
| ns, | |||
| resource, | |||
| url, | |||
route_doc = None, |
|||
| ** | kwargs | ||
| ) |
| def serialize_schema | ( | self, | |
| model | |||
| ) |
| def vendor_fields | ( | self, | |
| doc, | |||
| method | |||
| ) |
Extract custom 3rd party Vendor fields prefixed with ``x-`` See: http://swagger.io/specification/#specification-extensions-128
| api |