Skip to content

update documentation with options view method since version-3.2 #3489

Closed
@mikofski

Description

@mikofski

The documentation topic, documenting your api describes overriding the metadata view method as described in the version 3.0 updates notes. However since commit f4b1dcb I think this method has been changed to options.

Here is a patch:

--- documenting-your-api.md.orig    2015-10-12 14:52:15.036110300 -0700
+++ documenting-your-api.md 2015-10-12 14:52:45.168944300 -0700
@@ -81,11 +81,11 @@

 You can modify the response behavior to `OPTIONS` requests by overriding the `metadata` view method.  For example:

-    def metadata(self, request):
+    def options(self, request):
         """
         Don't include the view description in OPTIONS responses.
         """
-        data = super(ExampleView, self).metadata(request)
+        data = super(ExampleView, self).options(request)
         data.pop('description')
         return data

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions