encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-04-30 14:03:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix typo in links (#7289)

Browse Source 
Reference-style link should be enclosed in square brackets. Otherwise it is treated as an inline-style link.
This commit is contained in:
Victor Mireyev 2020-04-25 05:38:01 +03:00 committed by GitHub
parent 26cd52a461
commit 3eef5f47f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api-guide/schemas.md
View File

@ -290,7 +290,7 @@ class MyView(APIView):
### OperationId ### OperationId
The schema generator generates an [operationid](openapi-operationid) for each operation. This `operationId` is deduced from the model name, serializer name or view name. The operationId may looks like "listItems", "retrieveItem", "updateItem", etc.. The schema generator generates an [operationid][openapi-operationid] for each operation. This `operationId` is deduced from the model name, serializer name or view name. The operationId may looks like "listItems", "retrieveItem", "updateItem", etc..
The `operationId` is camelCase by convention. The `operationId` is camelCase by convention.
If you have several views with the same model, the generator may generate duplicate operationId. If you have several views with the same model, the generator may generate duplicate operationId.
@ -323,12 +323,12 @@ class MyView(APIView):
### Components ### Components
Since DRF 3.12, Schema uses the [OpenAPI Components](openapi-components). This method defines components in the schema and [references them](openapi-reference) inside request and response objects. By default, the component's name is deduced from the Serializer's name. Since DRF 3.12, Schema uses the [OpenAPI Components][openapi-components]. This method defines components in the schema and [references them][openapi-reference] inside request and response objects. By default, the component's name is deduced from the Serializer's name.
Using OpenAPI's components provides the following advantages: Using OpenAPI's components provides the following advantages:
* The schema is more readable and lightweight. * The schema is more readable and lightweight.
* If you use the schema to generate an SDK (using [openapi-generator](openapi-generator) or [swagger-codegen](swagger-codegen)). The generator can name your SDK's models. * If you use the schema to generate an SDK (using [openapi-generator][openapi-generator] or [swagger-codegen][swagger-codegen]). The generator can name your SDK's models.
### Handling component's schema errors ### Handling component's schema errors