Skip to content

Commit 211ed74

Browse files
committed
Fix several broken links
1 parent bffbb9c commit 211ed74

File tree

8 files changed

+18
-17
lines changed

8 files changed

+18
-17
lines changed

docs/api-guide/pagination.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,9 +312,10 @@ The [`drf-proxy-pagination` package][drf-proxy-pagination] includes a `ProxyPagi
312312

313313
## link-header-pagination
314314

315-
The [`django-rest-framework-link-header-pagination` package][drf-link-header-pagination] includes a `LinkHeaderPagination` class which provides pagination via an HTTP `Link` header as described in [Github's developer documentation](github-link-pagination).
315+
The [`django-rest-framework-link-header-pagination` package][drf-link-header-pagination] includes a `LinkHeaderPagination` class which provides pagination via an HTTP `Link` header as described in [Github's developer documentation][github-link-pagination].
316316

317317
[cite]: https://docs.djangoproject.com/en/stable/topics/pagination/
318+
[github-link-pagination]: https://developer.github.com/guides/traversing-with-pagination/
318319
[link-header]: ../img/link-header-pagination.png
319320
[drf-extensions]: https://chibisov.github.io/drf-extensions/docs/
320321
[paginate-by-max-mixin]: https://chibisov.github.io/drf-extensions/docs/#paginatebymaxmixin

docs/api-guide/schemas.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ class MyView(APIView):
290290

291291
### OperationId
292292

293-
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..
293+
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..
294294
The `operationId` is camelCase by convention.
295295

296296
If you have several views with the same model, the generator may generate duplicate operationId.
@@ -323,11 +323,11 @@ class MyView(APIView):
323323

324324
### Components
325325

326-
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.
326+
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:
329329
* The schema is more readable and lightweight.
330-
* 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.
330+
* 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.
331331

332332
### Handling component's schema errors
333333

docs/community/3.1-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The cursor based pagination renders a more simple style of control:
4646

4747
The pagination API was previously only able to alter the pagination style in the body of the response. The API now supports being able to write pagination information in response headers, making it possible to use pagination schemes that use the `Link` or `Content-Range` headers.
4848

49-
For more information, see the [custom pagination styles](../api-guide/pagination/#custom-pagination-styles) documentation.
49+
For more information, see the [custom pagination styles](../api-guide/pagination.md#custom-pagination-styles) documentation.
5050

5151
---
5252

docs/community/3.3-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The `ModelSerializer` and `HyperlinkedModelSerializer` classes should now includ
5454

5555
[forms-api]: ../topics/html-and-forms.md
5656
[ajax-form]: https://github.com/encode/ajax-form
57-
[jsonfield]: ../api-guide/fields#jsonfield
57+
[jsonfield]: ../api-guide/fields.md#jsonfield
5858
[accept-headers]: ../topics/browser-enhancements.md#url-based-accept-headers
5959
[method-override]: ../topics/browser-enhancements.md#http-header-based-method-overriding
6060
[django-supported-versions]: https://www.djangoproject.com/download/#supported-versions

docs/community/3.4-announcement.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -179,16 +179,16 @@ The full set of itemized release notes [are available here][release-notes].
179179
[moss]: mozilla-grant.md
180180
[funding]: funding.md
181181
[core-api]: https://www.coreapi.org/
182-
[command-line-client]: api-clients#command-line-client
183-
[client-library]: api-clients#python-client-library
182+
[command-line-client]: ../topics/api-clients.md#command-line-client
183+
[client-library]: ../topics/api-clients.md#python-client-library
184184
[core-json]: https://www.coreapi.org/specification/encoding/#core-json-encoding
185185
[swagger]: https://openapis.org/specification
186186
[hyperschema]: https://json-schema.org/latest/json-schema-hypermedia.html
187187
[api-blueprint]: https://apiblueprint.org/
188-
[tut-7]: ../tutorial/7-schemas-and-client-libraries/
189-
[schema-generation]: ../api-guide/schemas/
188+
[tut-7]: ../coreapi/7-schemas-and-client-libraries.md
189+
[schema-generation]: ../api-guide/schemas.md
190190
[api-clients]: ../topics/api-clients.md
191191
[milestone]: https://github.com/encode/django-rest-framework/milestone/35
192-
[release-notes]: release-notes#34
193-
[metadata]: ../api-guide/metadata/#custom-metadata-classes
192+
[release-notes]: release-notes.md#34
193+
[metadata]: ../api-guide/metadata.md#custom-metadata-classes
194194
[gh3751]: https://github.com/encode/django-rest-framework/issues/3751

docs/community/3.5-announcement.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,9 @@ in version 3.3 and raised a deprecation warning in 3.4. Its usage is now mandato
258258
[funding]: funding.md
259259
[uploads]: https://core-api.github.io/python-client/api-guide/utils/#file
260260
[downloads]: https://core-api.github.io/python-client/api-guide/codecs/#downloadcodec
261-
[schema-generation-api]: ../api-guide/schemas/#schemagenerator
262-
[schema-docs]: ../api-guide/schemas/#schemas-as-documentation
263-
[schema-view]: ../api-guide/schemas/#the-get_schema_view-shortcut
261+
[schema-generation-api]: ../coreapi/schemas.md#schemagenerator
262+
[schema-docs]: ../coreapi/schemas.md#schemas-as-documentation
263+
[schema-view]: ../coreapi/schemas.md#the-get_schema_view-shortcut
264264
[django-rest-raml]: https://github.com/encode/django-rest-raml
265265
[raml-image]: ../img/raml.png
266266
[raml-codec]: https://github.com/core-api/python-raml-codec

docs/community/third-party-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque
288288
[drf-create-issue]: https://github.com/encode/django-rest-framework/issues/new
289289
[authentication]: ../api-guide/authentication.md
290290
[permissions]: ../api-guide/permissions.md
291-
[third-party-packages]: ../topics/third-party-packages/#existing-third-party-packages
291+
[third-party-packages]: #existing-third-party-packages
292292
[discussion-group]: https://groups.google.com/forum/#!forum/django-rest-framework
293293
[djangorestframework-digestauth]: https://github.com/juanriaza/django-rest-framework-digestauth
294294
[django-oauth-toolkit]: https://github.com/evonove/django-oauth-toolkit

docs/topics/documenting-your-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ To implement a hypermedia API you'll need to decide on an appropriate media type
209209
[cite]: https://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
210210

211211
[hypermedia-docs]: rest-hypermedia-hateoas.md
212-
[metadata-docs]: ../api-guide/metadata/
212+
[metadata-docs]: ../api-guide/metadata.md
213213
[schemas-examples]: ../api-guide/schemas/#examples
214214

215215
[image-drf-yasg]: ../img/drf-yasg.png

0 commit comments

Comments
 (0)