OpenQuizz
Une application de gestion des contenus pédagogiques
Swagger Class Reference
Inheritance diagram for Swagger:
Collaboration diagram for Swagger:

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
 

Detailed Description

A Swagger documentation wrapper for an API instance.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  api 
)

Member Function Documentation

◆ as_dict()

def as_dict (   self)
Output the specification as a serializable ``dict``.

:returns: the full Swagger specification in a serializable format
:rtype: dict

◆ description_for()

def description_for (   self,
  doc,
  method 
)
Extract the description metadata and fallback on the whole docstring

◆ expected_params()

def expected_params (   self,
  doc 
)

◆ extract_resource_doc()

def extract_resource_doc (   self,
  resource,
  url,
  route_doc = None 
)

◆ extract_tags()

def extract_tags (   self,
  api 
)

◆ get_host()

def get_host (   self)

◆ operation_id_for()

def operation_id_for (   self,
  doc,
  method 
)
Extract the operation id

◆ parameters_for()

def parameters_for (   self,
  doc 
)

◆ process_headers()

def process_headers (   self,
  response,
  doc,
  method = None,
  headers = None 
)

◆ register_errors()

def register_errors (   self)

◆ register_field()

def register_field (   self,
  field 
)

◆ register_model()

def register_model (   self,
  model 
)

◆ responses_for()

def responses_for (   self,
  doc,
  method 
)

◆ security_for()

def security_for (   self,
  doc,
  method 
)

◆ security_requirement()

def security_requirement (   self,
  value 
)

◆ security_requirements()

def security_requirements (   self,
  value 
)

◆ serialize_definitions()

def serialize_definitions (   self)

◆ serialize_operation()

def serialize_operation (   self,
  doc,
  method 
)

◆ serialize_resource()

def serialize_resource (   self,
  ns,
  resource,
  url,
  route_doc = None,
**  kwargs 
)

◆ serialize_schema()

def serialize_schema (   self,
  model 
)

◆ vendor_fields()

def vendor_fields (   self,
  doc,
  method 
)
Extract custom 3rd party Vendor fields prefixed with ``x-``

See: http://swagger.io/specification/#specification-extensions-128

Field Documentation

◆ api

api

The documentation for this class was generated from the following file: