{{title}}
-{{summary}}
-diff --git a/site/__init__.py b/site/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/site/base.html b/site/base.html deleted file mode 100644 index a38b4cf4..00000000 --- a/site/base.html +++ /dev/null @@ -1,103 +0,0 @@ - - -
- - - - {% if page_description %}{% endif %} - {% if site_author %}{% endif %} - {% if canonical_url %}{% endif %} - {% if favicon %} - {% else %}{% endif %} - -Swagger/OpenAPI Documentation Generator for Django REST Framework
- - -Note: you are viewing documentation for version 2, using Django REST Framework 3.4+ and CoreAPI. Documentation for previous versions is available here.
-$ pip install django-rest-swagger
Add 'rest_framework_swagger'
to INSTALLED_APPS
in Django settings.
settings.py
-INSTALLED_APPS = [
- ...
- 'rest_framework_swagger',
- ...
-]
-
-
-To render the Swagger UI, set the Django REST Framework schema view rendere classes to include
-OpenAPIRenderer
and the SwaggerUIRenderer
classes from rest_framework_swagger.renderers
.
The OpenAPIRenderer
is responsible for generating the JSON spec, while the SwaggerUIRenderer
renders
-the UI.
Note: to render the UI, both renderers must be included. The OpenAPIRenderer
may be used on its own if you wish to host the UI independently.
views.py
-from rest_framework.decorators import api_view, renderer_classes
-from rest_framework import schemas
-from rest_framework_swagger import OpenAPIRenderer, SwaggerUIRenderer
-
-generator = schemas.SchemaGenerator(title='Bookings API')
-
-@api_view()
-@renderer_classes([OpenAPIRenderer, SwaggerUIRenderer])
-def schema_view(request):
- return generator.get_schema(request=request)
-
-
-
-
-urls.py
-from django.conf.urls import url
-from views import schema_view
-
-urlpatterns = [
- url('/', schema_view),
- ...
-]
-
-
-Version 2.0 is fundamentally different from previous versions and leverages the new schema generation features introduced in Django REST Framework 3.4. Introspection is performed by the framework and uses CoreAPI to store definitions. This is a breaking change from previous versions which were responsible for introspection as well as overrides.
-New:
-Deprecated:
-Copyright (c) 2013-2016, Marc Gibbons
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
{{summary}}
-No results found
"); - } - - if(jQuery){ - /* - * We currently only automatically hide bootstrap models. This - * requires jQuery to work. - */ - jQuery('#mkdocs_search_modal a').click(function(){ - jQuery('#mkdocs_search_modal').modal('hide'); - }) - } - - }; - - var search_input = document.getElementById('mkdocs-search-query'); - - var term = getSearchTerm(); - if (term){ - search_input.value = term; - search(); - } - - search_input.addEventListener("keyup", search); - -}); diff --git a/site/mkdocs/js/text.js b/site/mkdocs/js/text.js deleted file mode 100644 index 17921b6e..00000000 --- a/site/mkdocs/js/text.js +++ /dev/null @@ -1,390 +0,0 @@ -/** - * @license RequireJS text 2.0.12 Copyright (c) 2010-2014, The Dojo Foundation All Rights Reserved. - * Available via the MIT or new BSD license. - * see: http://github.com/requirejs/text for details - */ -/*jslint regexp: true */ -/*global require, XMLHttpRequest, ActiveXObject, - define, window, process, Packages, - java, location, Components, FileUtils */ - -define(['module'], function (module) { - 'use strict'; - - var text, fs, Cc, Ci, xpcIsWindows, - progIds = ['Msxml2.XMLHTTP', 'Microsoft.XMLHTTP', 'Msxml2.XMLHTTP.4.0'], - xmlRegExp = /^\s*<\?xml(\s)+version=[\'\"](\d)*.(\d)*[\'\"](\s)*\?>/im, - bodyRegExp = /]*>\s*([\s\S]+)\s*<\/body>/im, - hasLocation = typeof location !== 'undefined' && location.href, - defaultProtocol = hasLocation && location.protocol && location.protocol.replace(/\:/, ''), - defaultHostName = hasLocation && location.hostname, - defaultPort = hasLocation && (location.port || undefined), - buildMap = {}, - masterConfig = (module.config && module.config()) || {}; - - text = { - version: '2.0.12', - - strip: function (content) { - //Strips declarations so that external SVG and XML - //documents can be added to a document without worry. Also, if the string - //is an HTML document, only the part inside the body tag is returned. - if (content) { - content = content.replace(xmlRegExp, ""); - var matches = content.match(bodyRegExp); - if (matches) { - content = matches[1]; - } - } else { - content = ""; - } - return content; - }, - - jsEscape: function (content) { - return content.replace(/(['\\])/g, '\\$1') - .replace(/[\f]/g, "\\f") - .replace(/[\b]/g, "\\b") - .replace(/[\n]/g, "\\n") - .replace(/[\t]/g, "\\t") - .replace(/[\r]/g, "\\r") - .replace(/[\u2028]/g, "\\u2028") - .replace(/[\u2029]/g, "\\u2029"); - }, - - createXhr: masterConfig.createXhr || function () { - //Would love to dump the ActiveX crap in here. Need IE 6 to die first. - var xhr, i, progId; - if (typeof XMLHttpRequest !== "undefined") { - return new XMLHttpRequest(); - } else if (typeof ActiveXObject !== "undefined") { - for (i = 0; i < 3; i += 1) { - progId = progIds[i]; - try { - xhr = new ActiveXObject(progId); - } catch (e) {} - - if (xhr) { - progIds = [progId]; // so faster next time - break; - } - } - } - - return xhr; - }, - - /** - * Parses a resource name into its component parts. Resource names - * look like: module/name.ext!strip, where the !strip part is - * optional. - * @param {String} name the resource name - * @returns {Object} with properties "moduleName", "ext" and "strip" - * where strip is a boolean. - */ - parseName: function (name) { - var modName, ext, temp, - strip = false, - index = name.indexOf("."), - isRelative = name.indexOf('./') === 0 || - name.indexOf('../') === 0; - - if (index !== -1 && (!isRelative || index > 1)) { - modName = name.substring(0, index); - ext = name.substring(index + 1, name.length); - } else { - modName = name; - } - - temp = ext || modName; - index = temp.indexOf("!"); - if (index !== -1) { - //Pull off the strip arg. - strip = temp.substring(index + 1) === "strip"; - temp = temp.substring(0, index); - if (ext) { - ext = temp; - } else { - modName = temp; - } - } - - return { - moduleName: modName, - ext: ext, - strip: strip - }; - }, - - xdRegExp: /^((\w+)\:)?\/\/([^\/\\]+)/, - - /** - * Is an URL on another domain. Only works for browser use, returns - * false in non-browser environments. Only used to know if an - * optimized .js version of a text resource should be loaded - * instead. - * @param {String} url - * @returns Boolean - */ - useXhr: function (url, protocol, hostname, port) { - var uProtocol, uHostName, uPort, - match = text.xdRegExp.exec(url); - if (!match) { - return true; - } - uProtocol = match[2]; - uHostName = match[3]; - - uHostName = uHostName.split(':'); - uPort = uHostName[1]; - uHostName = uHostName[0]; - - return (!uProtocol || uProtocol === protocol) && - (!uHostName || uHostName.toLowerCase() === hostname.toLowerCase()) && - ((!uPort && !uHostName) || uPort === port); - }, - - finishLoad: function (name, strip, content, onLoad) { - content = strip ? text.strip(content) : content; - if (masterConfig.isBuild) { - buildMap[name] = content; - } - onLoad(content); - }, - - load: function (name, req, onLoad, config) { - //Name has format: some.module.filext!strip - //The strip part is optional. - //if strip is present, then that means only get the string contents - //inside a body tag in an HTML string. For XML/SVG content it means - //removing the declarations so the content can be inserted - //into the current doc without problems. - - // Do not bother with the work if a build and text will - // not be inlined. - if (config && config.isBuild && !config.inlineText) { - onLoad(); - return; - } - - masterConfig.isBuild = config && config.isBuild; - - var parsed = text.parseName(name), - nonStripName = parsed.moduleName + - (parsed.ext ? '.' + parsed.ext : ''), - url = req.toUrl(nonStripName), - useXhr = (masterConfig.useXhr) || - text.useXhr; - - // Do not load if it is an empty: url - if (url.indexOf('empty:') === 0) { - onLoad(); - return; - } - - //Load the text. Use XHR if possible and in a browser. - if (!hasLocation || useXhr(url, defaultProtocol, defaultHostName, defaultPort)) { - text.get(url, function (content) { - text.finishLoad(name, parsed.strip, content, onLoad); - }, function (err) { - if (onLoad.error) { - onLoad.error(err); - } - }); - } else { - //Need to fetch the resource across domains. Assume - //the resource has been optimized into a JS module. Fetch - //by the module name + extension, but do not include the - //!strip part to avoid file system issues. - req([nonStripName], function (content) { - text.finishLoad(parsed.moduleName + '.' + parsed.ext, - parsed.strip, content, onLoad); - }); - } - }, - - write: function (pluginName, moduleName, write, config) { - if (buildMap.hasOwnProperty(moduleName)) { - var content = text.jsEscape(buildMap[moduleName]); - write.asModule(pluginName + "!" + moduleName, - "define(function () { return '" + - content + - "';});\n"); - } - }, - - writeFile: function (pluginName, moduleName, req, write, config) { - var parsed = text.parseName(moduleName), - extPart = parsed.ext ? '.' + parsed.ext : '', - nonStripName = parsed.moduleName + extPart, - //Use a '.js' file name so that it indicates it is a - //script that can be loaded across domains. - fileName = req.toUrl(parsed.moduleName + extPart) + '.js'; - - //Leverage own load() method to load plugin value, but only - //write out values that do not have the strip argument, - //to avoid any potential issues with ! in file names. - text.load(nonStripName, req, function (value) { - //Use own write() method to construct full module value. - //But need to create shell that translates writeFile's - //write() to the right interface. - var textWrite = function (contents) { - return write(fileName, contents); - }; - textWrite.asModule = function (moduleName, contents) { - return write.asModule(moduleName, fileName, contents); - }; - - text.write(pluginName, nonStripName, textWrite, config); - }, config); - } - }; - - if (masterConfig.env === 'node' || (!masterConfig.env && - typeof process !== "undefined" && - process.versions && - !!process.versions.node && - !process.versions['node-webkit'])) { - //Using special require.nodeRequire, something added by r.js. - fs = require.nodeRequire('fs'); - - text.get = function (url, callback, errback) { - try { - var file = fs.readFileSync(url, 'utf8'); - //Remove BOM (Byte Mark Order) from utf8 files if it is there. - if (file.indexOf('\uFEFF') === 0) { - file = file.substring(1); - } - callback(file); - } catch (e) { - if (errback) { - errback(e); - } - } - }; - } else if (masterConfig.env === 'xhr' || (!masterConfig.env && - text.createXhr())) { - text.get = function (url, callback, errback, headers) { - var xhr = text.createXhr(), header; - xhr.open('GET', url, true); - - //Allow plugins direct access to xhr headers - if (headers) { - for (header in headers) { - if (headers.hasOwnProperty(header)) { - xhr.setRequestHeader(header.toLowerCase(), headers[header]); - } - } - } - - //Allow overrides specified in config - if (masterConfig.onXhr) { - masterConfig.onXhr(xhr, url); - } - - xhr.onreadystatechange = function (evt) { - var status, err; - //Do not explicitly handle errors, those should be - //visible via console output in the browser. - if (xhr.readyState === 4) { - status = xhr.status || 0; - if (status > 399 && status < 600) { - //An http 4xx or 5xx error. Signal an error. - err = new Error(url + ' HTTP status: ' + status); - err.xhr = xhr; - if (errback) { - errback(err); - } - } else { - callback(xhr.responseText); - } - - if (masterConfig.onXhrComplete) { - masterConfig.onXhrComplete(xhr, url); - } - } - }; - xhr.send(null); - }; - } else if (masterConfig.env === 'rhino' || (!masterConfig.env && - typeof Packages !== 'undefined' && typeof java !== 'undefined')) { - //Why Java, why is this so awkward? - text.get = function (url, callback) { - var stringBuffer, line, - encoding = "utf-8", - file = new java.io.File(url), - lineSeparator = java.lang.System.getProperty("line.separator"), - input = new java.io.BufferedReader(new java.io.InputStreamReader(new java.io.FileInputStream(file), encoding)), - content = ''; - try { - stringBuffer = new java.lang.StringBuffer(); - line = input.readLine(); - - // Byte Order Mark (BOM) - The Unicode Standard, version 3.0, page 324 - // http://www.unicode.org/faq/utf_bom.html - - // Note that when we use utf-8, the BOM should appear as "EF BB BF", but it doesn't due to this bug in the JDK: - // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4508058 - if (line && line.length() && line.charAt(0) === 0xfeff) { - // Eat the BOM, since we've already found the encoding on this file, - // and we plan to concatenating this buffer with others; the BOM should - // only appear at the top of a file. - line = line.substring(1); - } - - if (line !== null) { - stringBuffer.append(line); - } - - while ((line = input.readLine()) !== null) { - stringBuffer.append(lineSeparator); - stringBuffer.append(line); - } - //Make sure we return a JavaScript string and not a Java string. - content = String(stringBuffer.toString()); //String - } finally { - input.close(); - } - callback(content); - }; - } else if (masterConfig.env === 'xpconnect' || (!masterConfig.env && - typeof Components !== 'undefined' && Components.classes && - Components.interfaces)) { - //Avert your gaze! - Cc = Components.classes; - Ci = Components.interfaces; - Components.utils['import']('resource://gre/modules/FileUtils.jsm'); - xpcIsWindows = ('@mozilla.org/windows-registry-key;1' in Cc); - - text.get = function (url, callback) { - var inStream, convertStream, fileObj, - readData = {}; - - if (xpcIsWindows) { - url = url.replace(/\//g, '\\'); - } - - fileObj = new FileUtils.File(url); - - //XPCOM, you so crazy - try { - inStream = Cc['@mozilla.org/network/file-input-stream;1'] - .createInstance(Ci.nsIFileInputStream); - inStream.init(fileObj, 1, 0, false); - - convertStream = Cc['@mozilla.org/intl/converter-input-stream;1'] - .createInstance(Ci.nsIConverterInputStream); - convertStream.init(inStream, "utf-8", inStream.available(), - Ci.nsIConverterInputStream.DEFAULT_REPLACEMENT_CHARACTER); - - convertStream.readString(inStream.available(), readData); - convertStream.close(); - inStream.close(); - callback(readData.value); - } catch (e) { - throw new Error((fileObj && fileObj.path || '') + ': ' + e); - } - }; - } - return text; -}); diff --git a/site/mkdocs/search_index.json b/site/mkdocs/search_index.json deleted file mode 100644 index 0ac56ffd..00000000 --- a/site/mkdocs/search_index.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "docs": [ - { - "location": "/", - "text": "Django REST Swagger\n\n\nSwagger/OpenAPI Documentation Generator for Django REST Framework\n\n\n\n\n\n\n\nNote:\n you are viewing documentation for version 2, using Django REST Framework 3.4+ and CoreAPI. Documentation for previous versions is available \nhere\n.\n\n\n\n\nInstallation\n\n\n$ pip install django-rest-swagger\n\n\nAdd \n'rest_framework_swagger'\n to \nINSTALLED_APPS\n in Django settings.\n\n\nsettings.py\n\n\nINSTALLED_APPS = [\n ...\n 'rest_framework_swagger',\n ...\n]\n\n\n\n\nQuick start\n\n\nTo render the Swagger UI, set the Django REST Framework schema view rendere classes to include\n\nOpenAPIRenderer\n and the \nSwaggerUIRenderer\n classes from \nrest_framework_swagger.renderers\n.\n\n\nThe \nOpenAPIRenderer\n is responsible for generating the JSON spec, while the \nSwaggerUIRenderer\n renders\nthe UI.\n\n\nNote:\n to render the UI, both renderers must be included. The \nOpenAPIRenderer\n may be used on its own if you wish to host the UI independently.\n\n\nExample\n\n\nviews.py\n\n\nfrom rest_framework.decorators import api_view, renderer_classes\nfrom rest_framework import schemas\nfrom rest_framework_swagger import OpenAPIRenderer, SwaggerUIRenderer\n\ngenerator = schemas.SchemaGenerator(title='Bookings API')\n\n@api_view()\n@renderer_classes([OpenAPIRenderer, SwaggerUIRenderer])\ndef schema_view(request):\n return generator.get_schema(request=request)\n\n\n\n\n\n\nurls.py\n\n\nfrom django.conf.urls import url\nfrom views import schema_view\n\nurlpatterns = [\n url('/', schema_view),\n ...\n]\n\n\n\n\nView in the browser\n\n\n\n\nChanges in 2.0\n\n\nVersion 2.0 is fundamentally different from previous versions and leverages the new schema generation features introduced in Django REST Framework 3.4. Introspection is performed by the framework and uses CoreAPI to store definitions. This is a breaking change from previous versions which were responsible for introspection as well as overrides.\n\n\nNew:\n\n\n\n\nSwaggerUI and the OpenAPI spec are renderer classes (simpler configuration)\n\n\nSwaggerUI 2.1.4\n\n\nImproved performance\n\n\nAllow multiple instances of Swagger UI in a single Django project\n\n\nAllow rendering the OpenAPI JSON spec independently\n\n\nImproved control of authentication mechanisms\n\n\n\n\nDeprecated:\n\n\n\n\nYAML docstrings\n\n\n\n\nLicense\n\n\nCopyright (c) 2013-2016, Marc Gibbons\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR\nANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\nON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.", - "title": "Home" - }, - { - "location": "/#django-rest-swagger", - "text": "Swagger/OpenAPI Documentation Generator for Django REST Framework Note: you are viewing documentation for version 2, using Django REST Framework 3.4+ and CoreAPI. Documentation for previous versions is available here .", - "title": "Django REST Swagger" - }, - { - "location": "/#installation", - "text": "$ pip install django-rest-swagger Add 'rest_framework_swagger' to INSTALLED_APPS in Django settings. settings.py INSTALLED_APPS = [\n ...\n 'rest_framework_swagger',\n ...\n]", - "title": "Installation" - }, - { - "location": "/#quick-start", - "text": "To render the Swagger UI, set the Django REST Framework schema view rendere classes to include OpenAPIRenderer and the SwaggerUIRenderer classes from rest_framework_swagger.renderers . The OpenAPIRenderer is responsible for generating the JSON spec, while the SwaggerUIRenderer renders\nthe UI. Note: to render the UI, both renderers must be included. The OpenAPIRenderer may be used on its own if you wish to host the UI independently.", - "title": "Quick start" - }, - { - "location": "/#example", - "text": "views.py from rest_framework.decorators import api_view, renderer_classes\nfrom rest_framework import schemas\nfrom rest_framework_swagger import OpenAPIRenderer, SwaggerUIRenderer\n\ngenerator = schemas.SchemaGenerator(title='Bookings API')\n\n@api_view()\n@renderer_classes([OpenAPIRenderer, SwaggerUIRenderer])\ndef schema_view(request):\n return generator.get_schema(request=request) urls.py from django.conf.urls import url\nfrom views import schema_view\n\nurlpatterns = [\n url('/', schema_view),\n ...\n]", - "title": "Example" - }, - { - "location": "/#view-in-the-browser", - "text": "", - "title": "View in the browser" - }, - { - "location": "/#changes-in-20", - "text": "Version 2.0 is fundamentally different from previous versions and leverages the new schema generation features introduced in Django REST Framework 3.4. Introspection is performed by the framework and uses CoreAPI to store definitions. This is a breaking change from previous versions which were responsible for introspection as well as overrides. New: SwaggerUI and the OpenAPI spec are renderer classes (simpler configuration) SwaggerUI 2.1.4 Improved performance Allow multiple instances of Swagger UI in a single Django project Allow rendering the OpenAPI JSON spec independently Improved control of authentication mechanisms Deprecated: YAML docstrings", - "title": "Changes in 2.0" - }, - { - "location": "/#license", - "text": "Copyright (c) 2013-2016, Marc Gibbons\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR\nANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\nON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.", - "title": "License" - }, - { - "location": "/settings/", - "text": "Settings\n\n\nThe configuration of Django REST Swagger is identical to Django REST Framework. Settings are configurable in \nsettings.py\n by defining \nSWAGGER_SETTINGS\n.\n\n\nExample:\n\n\nsettings.py\n\n\nSWAGGER_SETTINGS = {\n 'SECURITY_DEFINITIONS': {\n 'basic': {\n 'type': 'basic'\n }\n }\n}\n\n\n\n\nAuthentication\n\n\nUSE_SESSION_AUTH\n\n\nToggles the use of Django Auth as an authentication mechanism. Setting it to \nTrue\n will display\na login/logout button on the Swagger UI and post csrf_tokens to the API.\n\n\nDefault: \nTrue\n\n\nNote:\n The login/logout button relies on Django's \nLOGIN_URL\n and \nLOGOUT_URL\n settings which defaults to \n/accounts/login\n. Here's an example of how to configure using DRF's authentication endpoints.\n\n\nurls.py\n\n\nurlpatterns = [\n url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))\n]\n\n\n\n\nsettings.py\n\n\nLOGIN_URL = 'rest_framework:login'\nLOGOUT_URL = 'rest_framework:logout'\n\n\n\n\nSECURITY_DEFINITIONS\n\n\nThe security definitions configures which authentication methods can be used by Swagger. The schemes types currently supported by the OpenAPI 2.0 spec are \nbasic\n, \napiKey\n and \noauth2\n.\n\n\nFor more information on available options, please consult the OpenAPI \nSecurity Object Definition\n\n\nDefault: \n\n\n{\n 'basic': {\n 'type': 'basic'\n }\n}", - "title": "Settings" - }, - { - "location": "/settings/#settings", - "text": "The configuration of Django REST Swagger is identical to Django REST Framework. Settings are configurable in settings.py by defining SWAGGER_SETTINGS . Example: settings.py SWAGGER_SETTINGS = {\n 'SECURITY_DEFINITIONS': {\n 'basic': {\n 'type': 'basic'\n }\n }\n}", - "title": "Settings" - }, - { - "location": "/settings/#authentication", - "text": "", - "title": "Authentication" - }, - { - "location": "/settings/#use_session_auth", - "text": "Toggles the use of Django Auth as an authentication mechanism. Setting it to True will display\na login/logout button on the Swagger UI and post csrf_tokens to the API. Default: True Note: The login/logout button relies on Django's LOGIN_URL and LOGOUT_URL settings which defaults to /accounts/login . Here's an example of how to configure using DRF's authentication endpoints. urls.py urlpatterns = [\n url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))\n] settings.py LOGIN_URL = 'rest_framework:login'\nLOGOUT_URL = 'rest_framework:logout'", - "title": "USE_SESSION_AUTH" - }, - { - "location": "/settings/#security_definitions", - "text": "The security definitions configures which authentication methods can be used by Swagger. The schemes types currently supported by the OpenAPI 2.0 spec are basic , apiKey and oauth2 . For more information on available options, please consult the OpenAPI Security Object Definition Default: {\n 'basic': {\n 'type': 'basic'\n }\n}", - "title": "SECURITY_DEFINITIONS" - } - ] -} \ No newline at end of file diff --git a/site/sitemap.xml b/site/sitemap.xml deleted file mode 100644 index 4c6ed6c0..00000000 --- a/site/sitemap.xml +++ /dev/null @@ -1,20 +0,0 @@ - -