mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-26 11:33:59 +03:00
Fix some typos in documentation
This commit is contained in:
parent
e2c35920d1
commit
b352c8a24c
|
@ -113,7 +113,7 @@ The following third party packages provide additional metadata implementations.
|
||||||
[drf-schema-adapter][drf-schema-adapter] is a set of tools that makes it easier to provide schema information to frontend frameworks and libraries. It provides a metadata mixin as well as 2 metadata classes and several adapters suitable to generate [json-schema][json-schema] as well as schema information readable by various libraries.
|
[drf-schema-adapter][drf-schema-adapter] is a set of tools that makes it easier to provide schema information to frontend frameworks and libraries. It provides a metadata mixin as well as 2 metadata classes and several adapters suitable to generate [json-schema][json-schema] as well as schema information readable by various libraries.
|
||||||
|
|
||||||
You can also write your own adapter to work with your specific frontend.
|
You can also write your own adapter to work with your specific frontend.
|
||||||
If you whish to do so, it also provides an exporter that can export those schema information to json files.
|
If you wish to do so, it also provides an exporter that can export those schema information to json files.
|
||||||
|
|
||||||
[cite]: http://tools.ietf.org/html/rfc7231#section-4.3.7
|
[cite]: http://tools.ietf.org/html/rfc7231#section-4.3.7
|
||||||
[no-options]: https://www.mnot.net/blog/2012/10/29/NO_OPTIONS
|
[no-options]: https://www.mnot.net/blog/2012/10/29/NO_OPTIONS
|
||||||
|
|
|
@ -259,7 +259,7 @@ The [REST Condition][rest-condition] package is another extension for building c
|
||||||
|
|
||||||
## DRY Rest Permissions
|
## DRY Rest Permissions
|
||||||
|
|
||||||
The [DRY Rest Permissions][dry-rest-permissions] package provides the ability to define different permissions for individual default and custom actions. This package is made for apps with permissions that are derived from relationships defined in the app's data model. It also supports permission checks being returned to a client app through the API's serializer. Additionally it supports adding permissions to the default and custom list actions to restrict the data they retrive per user.
|
The [DRY Rest Permissions][dry-rest-permissions] package provides the ability to define different permissions for individual default and custom actions. This package is made for apps with permissions that are derived from relationships defined in the app's data model. It also supports permission checks being returned to a client app through the API's serializer. Additionally it supports adding permissions to the default and custom list actions to restrict the data they retrieve per user.
|
||||||
|
|
||||||
## Django Rest Framework Roles
|
## Django Rest Framework Roles
|
||||||
|
|
||||||
|
|
|
@ -241,7 +241,7 @@ Default:
|
||||||
If set, this maps the `'pk'` identifier in the URL conf onto the actual field
|
If set, this maps the `'pk'` identifier in the URL conf onto the actual field
|
||||||
name when generating a schema path parameter. Typically this will be `'id'`.
|
name when generating a schema path parameter. Typically this will be `'id'`.
|
||||||
This gives a more suitable representation as "primary key" is an implementation
|
This gives a more suitable representation as "primary key" is an implementation
|
||||||
detail, wheras "identifier" is a more general concept.
|
detail, whereas "identifier" is a more general concept.
|
||||||
|
|
||||||
Default: `True`
|
Default: `True`
|
||||||
|
|
||||||
|
|
|
@ -153,7 +153,7 @@ For more information, see the documentation on [customizing field mappings][cust
|
||||||
|
|
||||||
We've now moved a number of packages out of the core of REST framework, and into separately installable packages. If you're currently using these you don't need to worry, you simply need to `pip install` the new packages, and change any import paths.
|
We've now moved a number of packages out of the core of REST framework, and into separately installable packages. If you're currently using these you don't need to worry, you simply need to `pip install` the new packages, and change any import paths.
|
||||||
|
|
||||||
We're making this change in order to help distribute the maintainance workload, and keep better focus of the core essentials of the framework.
|
We're making this change in order to help distribute the maintenance workload, and keep better focus of the core essentials of the framework.
|
||||||
|
|
||||||
The change also means we can be more flexible with which external packages we recommend. For example, the excellently maintained [Django OAuth toolkit](https://github.com/evonove/django-oauth-toolkit) has now been promoted as our recommended option for integrating OAuth support.
|
The change also means we can be more flexible with which external packages we recommend. For example, the excellently maintained [Django OAuth toolkit](https://github.com/evonove/django-oauth-toolkit) has now been promoted as our recommended option for integrating OAuth support.
|
||||||
|
|
||||||
|
|
|
@ -89,7 +89,7 @@ Name | Support | PyPI pa
|
||||||
---------------------------------|-------------------------------------|--------------------------------
|
---------------------------------|-------------------------------------|--------------------------------
|
||||||
[Core JSON][core-json] | Schema generation & client support. | Built-in support in `coreapi`.
|
[Core JSON][core-json] | Schema generation & client support. | Built-in support in `coreapi`.
|
||||||
[Swagger / OpenAPI][swagger] | Schema generation & client support. | The `openapi-codec` package.
|
[Swagger / OpenAPI][swagger] | Schema generation & client support. | The `openapi-codec` package.
|
||||||
[JSON Hyper-Schema][hyperschema] | Currrently client support only. | The `hyperschema-codec` package.
|
[JSON Hyper-Schema][hyperschema] | Currently client support only. | The `hyperschema-codec` package.
|
||||||
[API Blueprint][api-blueprint] | Not yet available. | Not yet available.
|
[API Blueprint][api-blueprint] | Not yet available. | Not yet available.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
@ -217,7 +217,7 @@ credentials, headers and bookmarks:
|
||||||
|
|
||||||
# Python client library
|
# Python client library
|
||||||
|
|
||||||
The `coreapi` Python package allows you to programatically interact with any
|
The `coreapi` Python package allows you to programmatically interact with any
|
||||||
API that exposes a supported schema format.
|
API that exposes a supported schema format.
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
|
@ -102,7 +102,7 @@ Our gold sponsors include companies large and small. Many thanks for their signi
|
||||||
|
|
||||||
### Silver sponsors
|
### Silver sponsors
|
||||||
|
|
||||||
The serious financial contribution that our silver sponsors have made is very much appreciated. I'd like to say a particular thank you to individuals who have choosen to privately support the project at this level.
|
The serious financial contribution that our silver sponsors have made is very much appreciated. I'd like to say a particular thank you to individuals who have chosen to privately support the project at this level.
|
||||||
|
|
||||||
<ul class="sponsor silver">
|
<ul class="sponsor silver">
|
||||||
<li><a href="http://www.imtapps.com/" rel="nofollow" style="background-image:url(../../img/sponsors/3-imt_computer_services.png);">IMT Computer Services</a></li>
|
<li><a href="http://www.imtapps.com/" rel="nofollow" style="background-image:url(../../img/sponsors/3-imt_computer_services.png);">IMT Computer Services</a></li>
|
||||||
|
|
|
@ -228,7 +228,7 @@ You can determine your currently installed version using `pip freeze`:
|
||||||
* Fixed use of deprecated Query.aggregates. ([#4003][gh4003])
|
* Fixed use of deprecated Query.aggregates. ([#4003][gh4003])
|
||||||
* Fix blank lines around docstrings. ([#4002][gh4002])
|
* Fix blank lines around docstrings. ([#4002][gh4002])
|
||||||
* Fixed admin pagination when limit is 0. ([#3990][gh3990])
|
* Fixed admin pagination when limit is 0. ([#3990][gh3990])
|
||||||
* OrderingFilter adjustements. ([#3983][gh3983])
|
* OrderingFilter adjustments. ([#3983][gh3983])
|
||||||
* Non-required serializer related fields. ([#3976][gh3976])
|
* Non-required serializer related fields. ([#3976][gh3976])
|
||||||
* Using safer calling way of "@api_view" in tutorial. ([#3971][gh3971])
|
* Using safer calling way of "@api_view" in tutorial. ([#3971][gh3971])
|
||||||
* ListSerializer doesn't handle unique_together constraints. ([#3970][gh3970])
|
* ListSerializer doesn't handle unique_together constraints. ([#3970][gh3970])
|
||||||
|
|
Loading…
Reference in New Issue
Block a user