From 799c472733dfc87d1d997c057b197a23226fea10 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 15 Jul 2019 11:38:39 +0000 Subject: [PATCH] Deployed 6499378f with MkDocs version: 1.0.4 --- 404.html | 160 +- api-guide/authentication/index.html | 168 +- api-guide/caching/index.html | 140 +- api-guide/content-negotiation/index.html | 138 +- api-guide/exceptions/index.html | 138 +- api-guide/fields/index.html | 144 +- api-guide/filtering/index.html | 214 +- api-guide/format-suffixes/index.html | 140 +- api-guide/generic-views/index.html | 150 +- api-guide/metadata/index.html | 138 +- api-guide/pagination/index.html | 197 +- api-guide/parsers/index.html | 164 +- api-guide/permissions/index.html | 160 +- api-guide/relations/index.html | 164 +- api-guide/renderers/index.html | 182 +- api-guide/requests/index.html | 138 +- api-guide/responses/index.html | 138 +- api-guide/reverse/index.html | 138 +- api-guide/routers/index.html | 138 +- api-guide/schemas/index.html | 945 +-- api-guide/serializers/index.html | 166 +- api-guide/settings/index.html | 198 +- api-guide/status-codes/index.html | 146 +- api-guide/testing/index.html | 142 +- api-guide/throttling/index.html | 152 +- api-guide/validators/index.html | 142 +- api-guide/versioning/index.html | 138 +- api-guide/views/index.html | 142 +- api-guide/viewsets/index.html | 138 +- community/3.0-announcement/index.html | 160 +- community/3.1-announcement/index.html | 142 +- community/3.10-announcement/index.html | 603 ++ community/3.2-announcement/index.html | 138 +- community/3.3-announcement/index.html | 140 +- community/3.4-announcement/index.html | 150 +- community/3.5-announcement/index.html | 144 +- community/3.6-announcement/index.html | 144 +- community/3.7-announcement/index.html | 138 +- community/3.8-announcement/index.html | 138 +- community/3.9-announcement/index.html | 138 +- community/contributing/index.html | 138 +- community/funding/index.html | 138 +- community/jobs/index.html | 138 +- community/kickstarter-announcement/index.html | 138 +- community/mozilla-grant/index.html | 138 +- community/project-management/index.html | 138 +- community/release-notes/index.html | 156 +- community/third-party-packages/index.html | 146 +- community/tutorials-and-resources/index.html | 138 +- .../7-schemas-and-client-libraries/index.html | 146 +- coreapi/from-documenting-your-api/index.html | 630 ++ coreapi/index.html | 496 ++ coreapi/schemas/index.html | 1241 ++++ css/base.css | 324 + css/bootstrap-custom.min.css | 1 + css/font-awesome.min.css | 4 + fonts/fontawesome-webfont.eot | Bin 0 -> 165742 bytes fonts/fontawesome-webfont.svg | 2671 +++++++ fonts/fontawesome-webfont.ttf | Bin 0 -> 165548 bytes fonts/fontawesome-webfont.woff | Bin 0 -> 98024 bytes fonts/fontawesome-webfont.woff2 | Bin 0 -> 77160 bytes fonts/glyphicons-halflings-regular.eot | Bin 0 -> 20127 bytes fonts/glyphicons-halflings-regular.svg | 288 + fonts/glyphicons-halflings-regular.ttf | Bin 0 -> 45404 bytes fonts/glyphicons-halflings-regular.woff | Bin 0 -> 23424 bytes fonts/glyphicons-halflings-regular.woff2 | Bin 0 -> 18028 bytes index.html | 32 +- js/base.js | 216 + js/bootstrap-3.0.3.min.js | 7 + js/jquery-1.10.2.min.js | 6 + mkdocs/js/lunr.min.js | 7 - mkdocs/js/mustache.min.js | 1 - mkdocs/js/require.js | 36 - mkdocs/js/search-results-template.mustache | 4 - mkdocs/js/search.js | 88 - mkdocs/js/text.js | 390 -- mkdocs/search_index.json | 6194 ----------------- search/lunr.js | 2986 ++++++++ search/main.js | 96 + search/search_index.json | 1 + search/worker.js | 128 + sitemap.xml | 339 +- sitemap.xml.gz | Bin 0 -> 751 bytes topics/ajax-csrf-cors/index.html | 138 +- topics/api-clients/index.html | 138 +- topics/browsable-api/index.html | 138 +- topics/browser-enhancements/index.html | 154 +- topics/documenting-your-api/index.html | 368 +- topics/html-and-forms/index.html | 138 +- topics/internationalization/index.html | 138 +- topics/rest-hypermedia-hateoas/index.html | 138 +- topics/writable-nested-serializers/index.html | 510 ++ tutorial/1-serialization/index.html | 148 +- tutorial/2-requests-and-responses/index.html | 138 +- tutorial/3-class-based-views/index.html | 138 +- .../index.html | 146 +- .../index.html | 146 +- tutorial/6-viewsets-and-routers/index.html | 144 +- tutorial/quickstart/index.html | 148 +- 99 files changed, 15299 insertions(+), 12462 deletions(-) create mode 100644 community/3.10-announcement/index.html rename {tutorial => coreapi}/7-schemas-and-client-libraries/index.html (79%) create mode 100644 coreapi/from-documenting-your-api/index.html create mode 100644 coreapi/index.html create mode 100644 coreapi/schemas/index.html create mode 100644 css/base.css create mode 100644 css/bootstrap-custom.min.css create mode 100644 css/font-awesome.min.css create mode 100644 fonts/fontawesome-webfont.eot create mode 100644 fonts/fontawesome-webfont.svg create mode 100644 fonts/fontawesome-webfont.ttf create mode 100644 fonts/fontawesome-webfont.woff create mode 100644 fonts/fontawesome-webfont.woff2 create mode 100644 fonts/glyphicons-halflings-regular.eot create mode 100644 fonts/glyphicons-halflings-regular.svg create mode 100644 fonts/glyphicons-halflings-regular.ttf create mode 100644 fonts/glyphicons-halflings-regular.woff create mode 100644 fonts/glyphicons-halflings-regular.woff2 create mode 100644 js/base.js create mode 100644 js/bootstrap-3.0.3.min.js create mode 100644 js/jquery-1.10.2.min.js delete mode 100644 mkdocs/js/lunr.min.js delete mode 100644 mkdocs/js/mustache.min.js delete mode 100644 mkdocs/js/require.js delete mode 100644 mkdocs/js/search-results-template.mustache delete mode 100644 mkdocs/js/search.js delete mode 100644 mkdocs/js/text.js delete mode 100644 mkdocs/search_index.json create mode 100644 search/lunr.js create mode 100644 search/main.js create mode 100644 search/search_index.json create mode 100644 search/worker.js create mode 100644 sitemap.xml.gz create mode 100644 topics/writable-nested-serializers/index.html diff --git a/404.html b/404.html index 7fae419b5..197d29d86 100644 --- a/404.html +++ b/404.html @@ -5,17 +5,17 @@ Django REST framework - + - - - - + + + + - - - + + + - - - + + + + + + + + +
+ + +
+
+ + + +
+
+
+ + +
+
+ +
+ + + + + +

Django REST framework 3.10

+

The 3.10 release drops support for Python 2.

+
    +
  • Our supported Python versions are now: 3.5, 3.6, and 3.7.
  • +
  • Our supported Django versions are now: 1.11, 2.0, 2.1, and 2.2.
  • +
+

OpenAPI Schema Generation

+

Since we first introduced schema support in Django REST Framework 3.5, OpenAPI has emerged as the widely adopted standard for modeling Web APIs.

+

This release begins the deprecation process for the CoreAPI based schema generation, and introduces OpenAPI schema generation in its place.

+
+

Continuing to use CoreAPI

+

If you're currently using the CoreAPI schemas, you'll need to make sure to +update your REST framework settings to include DEFAULT_SCHEMA_CLASS explicitly.

+

settings.py:

+
REST_FRAMEWORK = {
+  ...
+  'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
+}
+
+ +

You'll still be able to keep using CoreAPI schemas, API docs, and client for the +foreseeable future. We'll aim to ensure that the CoreAPI schema generator remains +available as a third party package, even once it has eventually been removed +from REST framework, scheduled for version 3.12.

+

We have removed the old documentation for the CoreAPI based schema generation. +You may view the Legacy CoreAPI documentation here.

+
+

OpenAPI Quickstart

+

You can generate a static OpenAPI schema, using the generateschema management +command.

+

Alternately, to have the project serve an API schema, use the get_schema_view() +shortcut.

+

In your urls.py:

+
from rest_framework.schemas import get_schema_view()
+
+urlpatterns = [
+    # ...
+    # Use the `get_schema_view()` helper to add a `SchemaView` to project URLs.
+    #   * `title` and `description` parameters are passed to `SchemaGenerator`.
+    #   * Provide view name for use with `reverse()`.
+    path('openapi', get_schema_view(
+        title="Your Project",
+        description="API for all things …"
+    ), name='openapi-schema'),
+    # ...
+]
+
+ +

Customization

+

For customizations that you want to apply across the the entire API, you can subclass rest_framework.schemas.openapi.SchemaGenerator and provide it as an argument +to the generateschema command or get_schema_view() helper function.

+

For specific per-view customizations, you can subclass AutoSchema, +making sure to set schema = <YourCustomClass> on the view.

+

For more details, see the API Schema documentation.

+

API Documentation

+

There are some great third party options for documenting your API, based on the +OpenAPI schema.

+

See the Documenting you API section for more details.

+
+

Feature Roadmap

+

Given that our OpenAPI schema generation is a new feature, it's likely that there +will still be some iterative improvements for us to make. There will be two +main cases here:

+
    +
  • Expanding the supported range of OpenAPI schemas that are generated by default.
  • +
  • Improving the ability for developers to customize the output.
  • +
+

We'll aim to bring the first type of change quickly in point releases. For the +second kind we'd like to adopt a slower approach, to make sure we keep the API +simple, and as widely applicable as possible, before we bring in API changes.

+

It's also possible that we'll end up implementing API documentation and API client +tooling that are driven by the OpenAPI schema. The apistar project has a +significant amount of work towards this. However, if we do so, we'll plan +on keeping any tooling outside of the core framework.

+
+

Funding

+

REST framework is a collaboratively funded project. If you use +REST framework commercially we strongly encourage you to invest in its +continued development by signing up for a paid plan.

+

Every single sign-up helps us make REST framework long-term financially sustainable.

+ + +
+ +

Many thanks to all our wonderful sponsors, and in particular to our premium backers, Sentry, Stream, ESG, Rollbar, Cadre, Kloudless, and Lights On Software.

+ + +
+
+
+
+
+
+ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/community/3.2-announcement/index.html b/community/3.2-announcement/index.html index 3e44d4a84..2da75d51a 100644 --- a/community/3.2-announcement/index.html +++ b/community/3.2-announcement/index.html @@ -58,10 +58,10 @@