Broken link in documentation

[rfleschenberg]

docs/topics/documenting-your-api.md says:

To provide descriptions for each view, such as for the the list and retrieve views, use docstring sections as described in Schemas as documentation: Examples.

And it links to [Schemas as documentation: Examples][schemas-examples], but that section does not exist.

it is in fact not clear from the docs how to solve this, or if that is currently possible.

[fhecorrea]

Same issue in docs/api-guide/schemas.md, a reference to an file named schemas.py that not exist:

---
source:
    - schemas.py
---

Sorry for my poor english.

[nezhar]

I made a PR that fixes the path for api-guide/schemas and also api-guide/metadata/, but the exapmple is missing on that page, probably due to the changes that involve Open API Schema generation.

[DanLipsitt]

Does anybody know if the examples from the legacy coreapi docs still apply and can be ported over?

[philgyford]

This is closed but the error is still in the documentation. Documenting your API reads:

Note that when using viewsets the basic docstring is used for all generated views. To provide descriptions for each view, such as for the list and retrieve views, use docstring sections as described in Schemas as documentation: Examples.

But there's no #examples section on the Schema page, and no mention of "docstring".

Having just switched from Views to ViewSets I wanted to know how to document the "list" and "retrieve" views separately, but I reached this dead end.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.