{
    "info": {
        "author": "Andres Rojano Ruiz",
        "author_email": "androiz10@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Framework :: Django",
            "Framework :: Django :: 1.10",
            "Framework :: Django :: 1.8",
            "Framework :: Django :: 1.9",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Natural Language :: English",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5"
        ],
        "description": "=============================\ndrf-swagger-customization\n=============================\n\n.. image:: https://badge.fury.io/py/drf-swagger-customization.svg\n    :target: https://badge.fury.io/py/drf-swagger-customization\n\n.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat\n    :target: http://drf-swagger-customization.readthedocs.io/en/latest/\n\nThis is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.\n\nDocumentation\n-------------\n\nThe full documentation is at https://drf-swagger-customization.readthedocs.io.\n\nQuickstart\n----------\n\nInstall drf-swagger-customization::\n\n    pip install drf-swagger-customization\n\n\nAdd these global variables to your settings.py:\n\n.. code-block:: python\n\n    EXTENSION_PATH = os.path.join(PROJECT_DIR, 'docs/doc_extension.json') # Path to your extension file\n    EXTERNAL_DOC_FOLDER = os.path.join(PROJECT_DIR, 'docs/external/') # Path to your external documentation folder\n\n\nAdd drf-swagger-customization's URL patterns:\n\n.. code-block:: python\n\n    from drf_swagger_customization.views import get_swagger_view\n\n    schema_view = get_swagger_view(title='Pastebin API')\n\n    urlpatterns = [\n        ...\n        url(r'^docs/$', schema_view),\n        ...\n    ]\n\nUsage\n--------\nWith this package we can increase the auto-generated documentation from django-swagger. That way, we can add documentation\nfrom external APIs or add more information to our drf API methods such as fields, remove endpoints, update attributes, and so on.\n\nIn order to add information to our EXTENSION_PATH json file,  we have available these operations:\n\nCreate\n~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: javascript\n\n    {\n        \"operation\": \"create\",\n        \"swagger-data\": {\n            \"paths|/v1/travels/|get|parameters\": [\n                {\n                  \"name\": \"Field1\",\n                  \"in\": \"query\",\n                  \"required\": true,\n                  \"type\": \"string\"\n                },\n                {\n                  \"name\": \"Field2\",\n                  \"in\": \"path\",\n                  \"required\": true,\n                  \"type\": \"integer\"\n                }\n            ]\n        }\n    }\n\nUpdate\n~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: javascript\n\n    {\n        \"operation\": \"update\",\n        \"swagger-data\": {\n            \"paths|/v1/travels/|get|parameters|field1\": {\n                \"name\": \"Field1\",\n                \"in\": \"query\",\n                \"required\": true,\n                \"type\": \"string\"\n            }\n        }\n    }\n\n\nRemove\n~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: javascript\n\n    {\n        \"operation\": \"delete\",\n        \"swagger-data\": \"paths|/v1/travels/|get|parameters|field1\"\n    }\n\nRename\n~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: javascript\n\n    {\n        \"action\": \"rename\",\n        \"operation\": {\n            \"paths|/v1/travels/\": \"/travels/\",\n            \"paths|/v1/travels/{id}/\": \"/travels/{id}/\"\n        }\n    }\n\n\nCompleted Sample\n--------\n\n.. code-block:: javascript\n\n    [\n      {\n        \"operation\": \"create\",\n        \"swagger-data\": {\n          \"paths|/v1/travels/|get|parameters\": [\n            {\n              \"name\": \"Field1\",\n              \"in\": \"query\",\n              \"required\": true,\n              \"type\": \"string\"\n            },\n            {\n              \"name\": \"Field2\",\n              \"in\": \"path\",\n              \"required\": true,\n              \"type\": \"integer\"\n            }\n          ]\n        }\n      },\n      {\n        \"operation\": \"update\",\n        \"swagger-data\": {\n          \"paths|/v1/travels/|get|parameters|field1\": {\n            \"name\": \"Field1\",\n            \"in\": \"query\",\n            \"required\": true,\n            \"type\": \"string\"\n          }\n        }\n      },\n      {\n        \"operation\": \"delete\",\n        \"swagger-data\": \"paths|/v1/travels/|get|parameters|field1\"\n      },\n      {\n        \"action\": \"rename\",\n        \"operation\": {\n            \"paths|/v1/travels/\": \"/travels/\",\n            \"paths|/v1/travels/{id}/\": \"/travels/{id}/\"\n        }\n      }\n    ]\n\n\nFuture Work\n--------\n\n* Add an example\n* Command for doc_file customization, in order to remove redundant executions.\n* Improve the settings options.\n\n\n\n\nHistory\n-------\n\n0.1.5 (2017-05-31)\n++++++++++++++++++\n\n* Added new action \"Rename\"\n\n0.1.4 (2017-05-30)\n++++++++++++++++++\n\n* Bugfix with documentation\n\n0.1.3 (2017-05-30)\n++++++++++++++++++\n\n* Bugfix with documentation\n\n0.1.2 (2017-05-30)\n++++++++++++++++++\n\n* Improved documentation in order to explain how to build the json file\n\n0.1.1 (2017-05-25)\n++++++++++++++++++\n\n* Fix in methods add, update and remove documentation.\n\n0.1.0 (2017-05-24)\n++++++++++++++++++\n\n* First release on PyPI.\n\n\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/androiz/drf-swagger-customization",
        "keywords": "drf-swagger-customization",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "drf-swagger-customization",
        "package_url": "https://pypi.org/project/drf-swagger-customization/",
        "platform": "",
        "project_url": "https://pypi.org/project/drf-swagger-customization/",
        "project_urls": {
            "Homepage": "https://github.com/androiz/drf-swagger-customization"
        },
        "release_url": "https://pypi.org/project/drf-swagger-customization/0.1.5/",
        "requires_dist": [
            "django-rest-swagger (>=2.0.5)",
            "djangorestframework (>=3.6.3)"
        ],
        "requires_python": "",
        "summary": "This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.",
        "version": "0.1.5"
    },
    "last_serial": 2913582,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bb3fdc9483967a00ae7f908c2a1421f9",
                    "sha256": "0595ab7b1e51dcc953f721acb769c4331893e96d8b8572554d301373a18aa653"
                },
                "downloads": -1,
                "filename": "drf-swagger-customization-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "bb3fdc9483967a00ae7f908c2a1421f9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7412,
                "upload_time": "2017-05-25T10:29:21",
                "url": "https://files.pythonhosted.org/packages/d0/80/400d6f8f9ec514caa9d9a17ccb9a72269c47c4233ce5e7faf1bc0f1c6df2/drf-swagger-customization-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0258944a775bde96e8141578a2ea6bde",
                    "sha256": "e0f2a5f9357ef7874dcf8de144d1803eb46c2144536f5c7ae452d059641fcbed"
                },
                "downloads": -1,
                "filename": "drf_swagger_customization-0.1.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0258944a775bde96e8141578a2ea6bde",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8587,
                "upload_time": "2017-05-30T18:29:08",
                "url": "https://files.pythonhosted.org/packages/1b/48/f78eeedd8e74de11d65ca03167dedf6a0abdfea0c08a20941be27e171fc4/drf_swagger_customization-0.1.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "28b8ae67e45665385859083b3f7568d0",
                    "sha256": "5b80241798c0e390530d9e09d1420398b4f9fc8dd9345bd4d93acdf5b94deb24"
                },
                "downloads": -1,
                "filename": "drf-swagger-customization-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "28b8ae67e45665385859083b3f7568d0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7766,
                "upload_time": "2017-05-30T18:28:50",
                "url": "https://files.pythonhosted.org/packages/63/0e/b5e03593ec261ef0c5386eab1817bd14dce4e923b78c04f6733546a64fd1/drf-swagger-customization-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "62c96bb38292b5972a63c38a61095764",
                    "sha256": "79f94c49c217eb2e7557cb90c80c605598c78d7b3c523805c86b66aebc7e0ed3"
                },
                "downloads": -1,
                "filename": "drf_swagger_customization-0.1.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "62c96bb38292b5972a63c38a61095764",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8658,
                "upload_time": "2017-05-30T18:40:45",
                "url": "https://files.pythonhosted.org/packages/a7/07/6495d269ad4d577b72a8c66a5549771adac614174bf53828c9b656d6245c/drf_swagger_customization-0.1.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "3da8dacb82395625bad08d6ccab960f9",
                    "sha256": "4874014dff8b87933b82251ed2584686e2ea5b79e5e1e01d50240e75f63aabdd"
                },
                "downloads": -1,
                "filename": "drf-swagger-customization-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "3da8dacb82395625bad08d6ccab960f9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7804,
                "upload_time": "2017-05-30T18:40:33",
                "url": "https://files.pythonhosted.org/packages/91/3e/dc100f79036263c7ac848319660ffce806a82cd574bc8ec4e4a0e01793c0/drf-swagger-customization-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "28d7d31b8fae2e0c0850779950fa3efb",
                    "sha256": "0d2337ff2782da3c245ff1699051c51570bf93a7c0a52ce64424d8edb3c068ad"
                },
                "downloads": -1,
                "filename": "drf_swagger_customization-0.1.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "28d7d31b8fae2e0c0850779950fa3efb",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8635,
                "upload_time": "2017-05-30T18:52:55",
                "url": "https://files.pythonhosted.org/packages/99/ef/d4647f241026950f44f84223ed5e70d16ddd6c7a35c22d673ffd2c931d15/drf_swagger_customization-0.1.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "850cf2f448d227ee18af221d4c391027",
                    "sha256": "ff01677e8693a8a18b5b1819cb4ca8814cd3e3bb9d6355083aa3374e152505e0"
                },
                "downloads": -1,
                "filename": "drf-swagger-customization-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "850cf2f448d227ee18af221d4c391027",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7811,
                "upload_time": "2017-05-30T18:52:58",
                "url": "https://files.pythonhosted.org/packages/53/b2/73fbcf11c312af85a364f98460dd8b415362e7de960d42ff42cfc5337b01/drf-swagger-customization-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8a5c7d4f6389d381d7cb0354887058ef",
                    "sha256": "cc38dc7306c9e43ad0f36491fea7c0e291bf4ee6a315d9249188fa4166975942"
                },
                "downloads": -1,
                "filename": "drf_swagger_customization-0.1.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8a5c7d4f6389d381d7cb0354887058ef",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8793,
                "upload_time": "2017-05-31T14:16:34",
                "url": "https://files.pythonhosted.org/packages/c9/ae/675f12581abf7f6a6d14191c45c421d21fa843d990ba245d5f54b5538e62/drf_swagger_customization-0.1.5-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "eb599d3afa646ee2f6bf5060100cf012",
                    "sha256": "f7c39083274df6625057b44511a956d8c1a23c23362fe48c17a1b1b977b6bd13"
                },
                "downloads": -1,
                "filename": "drf-swagger-customization-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "eb599d3afa646ee2f6bf5060100cf012",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8629,
                "upload_time": "2017-05-31T14:16:35",
                "url": "https://files.pythonhosted.org/packages/09/2a/36f3107bf0edc4c761f713b2e6090cce8ab457d156afcd3aa281ffa34fbd/drf-swagger-customization-0.1.5.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8a5c7d4f6389d381d7cb0354887058ef",
                "sha256": "cc38dc7306c9e43ad0f36491fea7c0e291bf4ee6a315d9249188fa4166975942"
            },
            "downloads": -1,
            "filename": "drf_swagger_customization-0.1.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8a5c7d4f6389d381d7cb0354887058ef",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 8793,
            "upload_time": "2017-05-31T14:16:34",
            "url": "https://files.pythonhosted.org/packages/c9/ae/675f12581abf7f6a6d14191c45c421d21fa843d990ba245d5f54b5538e62/drf_swagger_customization-0.1.5-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "eb599d3afa646ee2f6bf5060100cf012",
                "sha256": "f7c39083274df6625057b44511a956d8c1a23c23362fe48c17a1b1b977b6bd13"
            },
            "downloads": -1,
            "filename": "drf-swagger-customization-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "eb599d3afa646ee2f6bf5060100cf012",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8629,
            "upload_time": "2017-05-31T14:16:35",
            "url": "https://files.pythonhosted.org/packages/09/2a/36f3107bf0edc4c761f713b2e6090cce8ab457d156afcd3aa281ffa34fbd/drf-swagger-customization-0.1.5.tar.gz"
        }
    ]
}