{ "info": { "author": "Josip Delic", "author_email": "delijati@gmx.net", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "Cornice Swagger\n===============\n\n|pypi| |docs| |slack| |travis| |master-coverage|\n\n\n.. |travis| image:: https://travis-ci.org/Cornices/cornice.ext.swagger.png\n :target: https://travis-ci.org/Cornices/cornice.ext.swagger\n\n.. |master-coverage| image:: https://coveralls.io/repos/github/Cornices/cornice.ext.swagger/badge.svg?branch=master\n :target: https://coveralls.io/github/Cornices/cornice.ext.swagger?branch=master\n\n.. |pypi| image:: https://img.shields.io/pypi/v/cornice_swagger.svg\n :target: https://pypi.python.org/pypi/cornice_swagger\n\n.. |slack| image:: https://img.shields.io/badge/slack-chat-blue.svg\n :target: https://corniceswagger.herokuapp.com/\n\n.. |docs| image:: https://img.shields.io/badge/docs-gh--pages-ff69b4.svg\n :target: https://cornices.github.io/cornice.ext.swagger/\n\n\n*Cornice extension to generate OpenAPI/Swagger Specification*\n\nCornice Swagger creates an\n`OpenAPI/Swagger 2.0 compliant specification `_\nfrom `Cornice `_ applications\nmaximizing the extracted documentation data from functional code,\nwhile allowing users to override some parts of the generated document.\n\n\n* `Documentation `_\n* `Tutorial `_\n* `Issue tracker `_\n* `Live chat `_\n\n\n\nCHANGES\n=======\n\n0.7.0 (2018-07-29)\n------------------\n\n- Support swagger ``example`` field on colander ``SchemaNode`` custom kwarg::\n\n def SomeSchema(colander.MappingSchema):\n name = colander.SchemaNode(colander.String(), example='Mr. IceCream')\n\n The ``example`` field is returned in the swagger spec accordingly.\n\n\n0.6.0 (2018-03-28)\n------------------\n\n- Add ``cornice_enable_openapi_view()`` ``cornice_enable_openapi_explorer()``\n Pyramid directives to serve the API Explorer and the spec information (#79)\n\n\n0.5.5 (2018-03-19)\n------------------\n\n- Prevent failure with non-colander schemas (#78, thanks @ergo!)\n\n\n0.5.4 (2018-02-26)\n------------------\n\n**Internals**\n\n- Fix return types in docstrings (#77)\n\n\n0.5.3 (2018-02-14)\n------------------\n\n**Pyramid compliance**\n\n- Handle callables for ``cornice.service.Service.content_type`` argument.\n For more details, see: http://cornice.readthedocs.io/en/latest/api.html#cornice.service.Service.\n\n\n0.5.2 (2017-11-07)\n------------------\n\n**Internals**\n\n- Add classifiers to the Python package.\n\n\n0.5.1 (2017-04-10)\n------------------\n\n**Pyramid compliance**\n\n- Support subpaths and regex when parsing paths (#68).\n\n**Api**\n\n- ``_extract_path_from_service``, now returns the path name along with the path\n swagger object (#68).\n\n\n0.5.0 (2017-02-14)\n------------------\n\n**Api**\n\n- Allow implementing a custom generator by subclassing the ``CorniceSwagger`` class (#63).\n- Introduced a new method ``CorniceSwagger.generate`` to generate the spec (#63).\n- Deprecated ``CorniceSwagger`` call method. You should now use ``generate`` (#63).\n- Removed deprecated ``generate_swagger_spec`` call. (#64).\n- Allow defining custom type converters on the ``CorniceSwagger`` class. (#65)\n\n**Internals**\n\n- Fixed coveralls repeated messages on PRs. (#62).\n\n0.4.0 (2017-01-25)\n------------------\n\n**Api**\n\n- Summaries from docstrings are now not included by default. You can enable them by passing\n ``summary_docstrings = True`` to the generator.\n- Trying to document multiple views on same method now raises an exception. You should\n ignore the unwanted ones by content type.\n- Raw ``swagger`` items are now recursively merged (instead of replaced) with\n the extracted fields.\n- Add support for documenting operation ids via an ``operation_id`` argument on the view\n or by passing a ``default_op_ids`` callable to the generator.\n- Add a shortcut to the generator on ``cornice_swagger.CorniceSwagger``.\n- Support Cornice schema synonyms (headers and GET are the same as header and querystring).\n- Add support for documenting security properties via a ``api_security`` list on the view\n or by passing a ``default_security`` list or callable to the generator.\n\n**OpenAPI compliance**\n\n- Remove invalid ``title`` field from response headers and request parameters.\n- Support conversion of parameter validators.\n\n**Internals**\n\n- Fix default tag generator.\n- Fix references when using declarative schemas.\n- Simplify parameter converter by properly isolating ``body``.\n\n\n0.3.0 (2017-01-17)\n------------------\n\n**Api**\n\n- Use ``cornice_swagger.swagger.CorniceSwagger`` class to generate\n the swagger document rather then ``generate_swagger_spec``.\n- Allow overriding extractors in the application.\n- Schemas are now broken into JSON pointers only if specified.\n- Allow documenting responses via ``response_schemas`` view attribute.\n- Allow documenting tags via ``tags`` view attribute or using a\n ``default_tags`` parameter when calling the generator.\n\n**Internals**\n\n- Decouples converters from path generators.\n- Make considerable changes in the package organisation.\n- Reach 100% coverage on tests.\n\n**Documentation**\n\n- Create a Sphinx documentation hosted on\n https://cornices.github.io/cornice.ext.swagger.\n\n\n0.2.1 (2016-12-10)\n------------------\n\n- Check if schema is not instantiated.\n- Add support for query parameter description. [ridha]\n\n\n0.2 (2016-11-08)\n----------------\n\n- Pypi release.\n- Point scaffold doc to right url.\n\n\n0.1 (2016-11-05)\n----------------\n\n- First release for new cornice 2.0", "description_content_type": "", "docs_url": "https://pythonhosted.org/cornice-swagger/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Cornices/cornice.ext.swagger", "keywords": "web services", "license": "Apache License (2.0)", "maintainer": "", "maintainer_email": "", "name": "cornice-swagger", "package_url": "https://pypi.org/project/cornice-swagger/", "platform": "", "project_url": "https://pypi.org/project/cornice-swagger/", "project_urls": { "Homepage": "https://github.com/Cornices/cornice.ext.swagger" }, "release_url": "https://pypi.org/project/cornice-swagger/0.7.0/", "requires_dist": null, "requires_python": "", "summary": "Generate swagger from a Cornice application", "version": "0.7.0" }, "last_serial": 4114794, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "a6d312c13ee2930d76c8a282fffb5e29", "sha256": "d2c4b18b6f3e7ba75ad14926936c8e160fd2ce9ba5d51f9689cd398db27e97e4" }, "downloads": -1, "filename": "cornice_swagger-0.2.tar.gz", "has_sig": false, "md5_digest": "a6d312c13ee2930d76c8a282fffb5e29", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16271, "upload_time": "2016-11-08T12:44:17", "url": "https://files.pythonhosted.org/packages/d8/c5/9ecc5761f9cb39e6842e0804032019db1500f5f36e4f2fd15b42a990926e/cornice_swagger-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "fde6afb561744982949cd16e7d8e0f4f", "sha256": "32f9717108325cc61b9c8877fb918311c4776ce914ebb0dfa730acb91c212a92" }, "downloads": -1, "filename": "cornice_swagger-0.2.1.tar.gz", "has_sig": false, "md5_digest": "fde6afb561744982949cd16e7d8e0f4f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16514, "upload_time": "2016-12-10T11:41:03", "url": "https://files.pythonhosted.org/packages/cf/06/61d30e33a0ff4dadbb6855c6a7c1178a541dd02cd9fdfcd7cf722339fdae/cornice_swagger-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "ab98cce5a777ce2381525f2aaafe3fcf", "sha256": "4f69711534d74b55fea7977e52cd482403136bb9eddd3e6ca0f4f0f9f2d7b018" }, "downloads": -1, "filename": "cornice_swagger-0.3.0.tar.gz", "has_sig": false, "md5_digest": "ab98cce5a777ce2381525f2aaafe3fcf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18649, "upload_time": "2017-01-18T01:24:54", "url": "https://files.pythonhosted.org/packages/76/39/772860cc8992bfdb5a0fa06851354c3fe5cf839081814267479f2bf1f03a/cornice_swagger-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "eefc7c02e41cf64df8f133bee88bbbe6", "sha256": "4f00a3700d3b2caaa7c0574385be383b53b44dfad30eab8b9f792db6c931a9ef" }, "downloads": -1, "filename": "cornice_swagger-0.4.0.tar.gz", "has_sig": false, "md5_digest": "eefc7c02e41cf64df8f133bee88bbbe6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32768, "upload_time": "2017-01-25T16:46:52", "url": "https://files.pythonhosted.org/packages/0d/95/3710ace0728a29b4d234bc68b815891361866d910b181e35d871e2b0c1c6/cornice_swagger-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "48a24003d5294d24f724250eacf0aef7", "sha256": "a3171b33d939ab8577dc32d3dd8e4b45d9ace6e1bb8d49f0af220032e6c5308d" }, "downloads": -1, "filename": "cornice_swagger-0.5.0.tar.gz", "has_sig": false, "md5_digest": "48a24003d5294d24f724250eacf0aef7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32807, "upload_time": "2017-02-14T17:06:11", "url": "https://files.pythonhosted.org/packages/2a/97/9fc8ac427aeb6549a58cdce9e6830f15abf73aa4a00323e222acc2c64338/cornice_swagger-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "6f7849e6d52ac94584fea621d10210cc", "sha256": "b42a0923ee8bce314b0a88c61dd85b83ec621d888c4065fb6d77a6af3903509b" }, "downloads": -1, "filename": "cornice_swagger-0.5.1.tar.gz", "has_sig": false, "md5_digest": "6f7849e6d52ac94584fea621d10210cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33468, "upload_time": "2017-04-11T01:11:41", "url": "https://files.pythonhosted.org/packages/5b/6e/7a797e3670845fc71782486ac37701c4651ce210a49af0f573f4094e285e/cornice_swagger-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "7a439f727ee89fd0a821433dc2cb63ba", "sha256": "c0e394a412eaedca4efdee2636ceae97b94e9188ba5980ea216b6e0901fcc427" }, "downloads": -1, "filename": "cornice_swagger-0.5.2.tar.gz", "has_sig": false, "md5_digest": "7a439f727ee89fd0a821433dc2cb63ba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34138, "upload_time": "2017-11-07T14:21:54", "url": "https://files.pythonhosted.org/packages/41/76/8279a1ab75ca41d025f7ecc310132078e1ccbd94c50e77835d01b9983f44/cornice_swagger-0.5.2.tar.gz" } ], "0.5.3": [ { "comment_text": "", "digests": { "md5": "5a934a9e01ee2a23edca5039204be3fb", "sha256": "a153d14d081cb72af7879d5cab86323715b74bcfc5f6a49d87ba6411b3a1454f" }, "downloads": -1, "filename": "cornice_swagger-0.5.3.tar.gz", "has_sig": false, "md5_digest": "5a934a9e01ee2a23edca5039204be3fb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32805, "upload_time": "2018-02-14T11:55:26", "url": "https://files.pythonhosted.org/packages/37/6b/8e7037368fea48264ebb96c044f63da49e4bfbfe11dc92a5aee4d1872739/cornice_swagger-0.5.3.tar.gz" } ], "0.5.4": [ { "comment_text": "", "digests": { "md5": "945ed55fac758a9d1e835bb4d24564d8", "sha256": "2d2a765b61171b721b19b6701e402f86e50086af6657edd9188dcd9bbf5699a7" }, "downloads": -1, "filename": "cornice_swagger-0.5.4.tar.gz", "has_sig": false, "md5_digest": "945ed55fac758a9d1e835bb4d24564d8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32867, "upload_time": "2018-02-26T09:49:49", "url": "https://files.pythonhosted.org/packages/91/a8/7ee7b5709f990e5335266fb620644c4a3d55f621ab8e5ddfe04cfbfa333e/cornice_swagger-0.5.4.tar.gz" } ], "0.5.5": [ { "comment_text": "", "digests": { "md5": "60f3b5bf9bab043d389febb5279706dc", "sha256": "08dc0a39bf17cd071f7c6ca4e46f76dd41eee4c8ffd27f8cfa0eff6f7ca819df" }, "downloads": -1, "filename": "cornice_swagger-0.5.5.tar.gz", "has_sig": false, "md5_digest": "60f3b5bf9bab043d389febb5279706dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33061, "upload_time": "2018-03-19T10:49:53", "url": "https://files.pythonhosted.org/packages/aa/a3/87da537f344f83c3de0c50db877d644fa388fa6823974e2dda8f1e81ddce/cornice_swagger-0.5.5.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "db6cfefcfb03139956fa9186041e1099", "sha256": "22fc8de7a5b3b51268b847fcd1f58dbd50a0502e195cd8116b2956043dacfb7d" }, "downloads": -1, "filename": "cornice_swagger-0.6.0.tar.gz", "has_sig": false, "md5_digest": "db6cfefcfb03139956fa9186041e1099", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35836, "upload_time": "2018-03-28T15:06:09", "url": "https://files.pythonhosted.org/packages/61/b5/ce0a21f8a489846fcae10512e947afa1a7e1a777c5b50fd32f9229d0dbc9/cornice_swagger-0.6.0.tar.gz" } ], "0.7.0": [ { "comment_text": "", "digests": { "md5": "df32edd203201de0425df312a70205d0", "sha256": "740472ed535e74a4698d0140b67fa787c6772a1be8fc10175999f3b843cf40a1" }, "downloads": -1, "filename": "cornice_swagger-0.7.0.tar.gz", "has_sig": false, "md5_digest": "df32edd203201de0425df312a70205d0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38421, "upload_time": "2018-07-30T01:41:58", "url": "https://files.pythonhosted.org/packages/fc/6f/b3eaabfcb1a4688782d7a723cb7f9a159ec7e545adfc018391e1c0bb3322/cornice_swagger-0.7.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "df32edd203201de0425df312a70205d0", "sha256": "740472ed535e74a4698d0140b67fa787c6772a1be8fc10175999f3b843cf40a1" }, "downloads": -1, "filename": "cornice_swagger-0.7.0.tar.gz", "has_sig": false, "md5_digest": "df32edd203201de0425df312a70205d0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38421, "upload_time": "2018-07-30T01:41:58", "url": "https://files.pythonhosted.org/packages/fc/6f/b3eaabfcb1a4688782d7a723cb7f9a159ec7e545adfc018391e1c0bb3322/cornice_swagger-0.7.0.tar.gz" } ] }