Skip to content

Commit 26cd52a

Browse files
Fix markdown lists formatting. (#7288)
1 parent e133638 commit 26cd52a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/api-guide/schemas.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,7 @@ class MyView(APIView):
326326
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.
327327

328328
Using OpenAPI's components provides the following advantages:
329+
329330
* The schema is more readable and lightweight.
330331
* 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.
331332

@@ -347,6 +348,7 @@ Schema component "ComponentName" has been overriden with a different value.
347348
This warning occurs when different components have the same name in one schema. Your component name should be unique across your project. This is likely an error that may lead to an invalid schema.
348349

349350
You have two ways to solve the previous issues:
351+
350352
* You can rename your serializer with a unique name and another name than "Serializer".
351353
* You can set the `component_name` kwarg parameter of the AutoSchema constructor (see below).
352354
* You can override the `get_component_name` method of the AutoSchema class (see below).

0 commit comments

Comments
 (0)