Package: cornice-swagger
Cornice SwaggerCornice extension to generate OpenAPI/Swagger SpecificationCornice Swagger creates anOpenAPI/Swagger 2.0 compliant specificationfromCorniceapplications
maximizing the extracted documentation data from functional code,
while allowing users to override some parts of the generated document.DocumentationTutorialIssue trackerLive chatCHANGES1.0.1 (2021-08-30)Take default value from missing attribute (thanks @sp-schoen)1.0.0 (2020-03-31)Breaking ChangesDrop Python 2 supportInternal changesbump swagger-ui files to 3.23.110.7.0 (2018-07-29)Support swaggerexamplefield on colanderSchemaNodecustom kwarg:def SomeSchema(colander.MappingSchema):
    name = colander.SchemaNode(colander.String(), example='Mr. IceCream')Theexamplefield is returned in the swagger spec accordingly.0.6.0 (2018-03-28)Addcornice_enable_openapi_view()cornice_enable_openapi_explorer()Pyramid directives to serve the API Explorer and the spec information (#79)0.5.5 (2018-03-19)Prevent failure with non-colander schemas (#78, thanks @ergo!)0.5.4 (2018-02-26)InternalsFix return types in docstrings (#77)0.5.3 (2018-02-14)Pyramid complianceHandle callables forcornice.service.Service.content_typeargument.
For more details, see:http://cornice.readthedocs.io/en/latest/api.html#cornice.service.Service.0.5.2 (2017-11-07)InternalsAdd classifiers to the Python package.0.5.1 (2017-04-10)Pyramid complianceSupport subpaths and regex when parsing paths (#68).Api_extract_path_from_service, now returns the path name along with the path
swagger object (#68).0.5.0 (2017-02-14)ApiAllow implementing a custom generator by subclassing theCorniceSwaggerclass (#63).Introduced a new methodCorniceSwagger.generateto generate the spec (#63).DeprecatedCorniceSwaggercall method. You should now usegenerate(#63).Removed deprecatedgenerate_swagger_speccall. (#64).Allow defining custom type converters on theCorniceSwaggerclass. (#65)InternalsFixed coveralls repeated messages on PRs. (#62).0.4.0 (2017-01-25)ApiSummaries from docstrings are now not included by default. You can enable them by passingsummary_docstrings = Trueto the generator.Trying to document multiple views on same method now raises an exception. You should
ignore the unwanted ones by content type.Rawswaggeritems are now recursively merged (instead of replaced) with
the extracted fields.Add support for documenting operation ids via anoperation_idargument on the view
or by passing adefault_op_idscallable to the generator.Add a shortcut to the generator oncornice_swagger.CorniceSwagger.Support Cornice schema synonyms (headers and GET are the same as header and querystring).Add support for documenting security properties via aapi_securitylist on the view
or by passing adefault_securitylist or callable to the generator.OpenAPI complianceRemove invalidtitlefield from response headers and request parameters.Support conversion of parameter validators.InternalsFix default tag generator.Fix references when using declarative schemas.Simplify parameter converter by properly isolatingbody.0.3.0 (2017-01-17)ApiUsecornice_swagger.swagger.CorniceSwaggerclass to generate
the swagger document rather thengenerate_swagger_spec.Allow overriding extractors in the application.Schemas are now broken into JSON pointers only if specified.Allow documenting responses viaresponse_schemasview attribute.Allow documenting tags viatagsview attribute or using adefault_tagsparameter when calling the generator.InternalsDecouples converters from path generators.Make considerable changes in the package organisation.Reach 100% coverage on tests.DocumentationCreate a Sphinx documentation hosted onhttps://cornices.github.io/cornice.ext.swagger.0.2.1 (2016-12-10)Check if schema is not instantiated.Add support for query parameter description. [ridha]0.2 (2016-11-08)Pypi release.Point scaffold doc to right url.0.1 (2016-11-05)First release for new cornice 2.0