Commitab0c577

authored and

committed

Direct readers to info on how to add viewset docs (#4844)

I believe the original statement was wrong. You can, in fact, document the various API endpoints of a ViewSet.

1 parent6b399f1 commitab0c577Copy full SHA for ab0c577

File tree

-1

lines changed

-1

lines changed

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -105,7 +105,7 @@ If the python `markdown` library is installed, then [markdown syntax][markdown]
`105`	`105`	`[ref]: http://example.com/activating-accounts`
`106`	`106`	`"""`
`107`	`107`
`108`		`-Note thatone constraint ofusing viewsetsis that any documentation beused for all generated views, so for example, you cannot have differing documentationfor thegenerated listviewanddetail view.`
	`108`	`+Note thatwhenusing viewsetsthe basic docstring isused for all generated views. To provide descriptions for each view, such asfor thethe list andretrieve views, use docstring sections as described in[Schemas as documentation: Examples][schemas-examples].`
`109`	`109`
`110`	`110`	####The`OPTIONS` method
`111`	`111`
`@@ -148,3 +148,4 @@ To implement a hypermedia API you'll need to decide on an appropriate media type`
`148`	`148`	`[image-django-rest-swagger]:../img/django-rest-swagger.png`
`149`	`149`	`[image-apiary]:../img/apiary.png`
`150`	`150`	`[image-self-describing-api]:../img/self-describing.png`
	`151`	`+[schemas-examples]:api-guide/schemas/#examples`

Comments

(0)