Support swagger example
field on colander SchemaNode
custom kwarg:
def SomeSchema(colander.MappingSchema):
name = colander.SchemaNode(colander.String(), example='Mr. IceCream')
The example
field is returned in the swagger spec accordingly.
cornice_enable_openapi_view()
cornice_enable_openapi_explorer()
Pyramid directives to serve the API Explorer and the spec information (#79)Pyramid compliance
cornice.service.Service.content_type
argument.
For more details, see: http://cornice.readthedocs.io/en/latest/api.html#cornice.service.Service.Pyramid compliance
Api
_extract_path_from_service
, now returns the path name along with the path
swagger object (#68).Api
CorniceSwagger
class (#63).CorniceSwagger.generate
to generate the spec (#63).CorniceSwagger
call method. You should now use generate
(#63).generate_swagger_spec
call. (#64).CorniceSwagger
class. (#65)Internals
Api
summary_docstrings = True
to the generator.swagger
items are now recursively merged (instead of replaced) with
the extracted fields.operation_id
argument on the view
or by passing a default_op_ids
callable to the generator.cornice_swagger.CorniceSwagger
.api_security
list on the view
or by passing a default_security
list or callable to the generator.OpenAPI compliance
title
field from response headers and request parameters.Internals
body
.Api
cornice_swagger.swagger.CorniceSwagger
class to generate
the swagger document rather then generate_swagger_spec
.response_schemas
view attribute.tags
view attribute or using a
default_tags
parameter when calling the generator.Internals
Documentation