paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-02 04:53:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

openapi: Add intentionally_undocumentated parameter to REQ.

Browse Source 
This will allow us to mark a REQ variable as intentionally
undocumented. With this, we can remove some of the endpoints marked
as "buggy" even though they're not actually buggy, we just needed to
specify certain parameters as intentionally undocumented (e.g. the
stream_id for the /users/me/subscriptions/muted_topics endpoint.)

Any REQ variable with intentionally_undocumentated set to True
will not be added to the arguments_map data structure.

For some of the other "buggy" endpoints, we would want to mark the
entire endpoint as being undocumented intentionally via. the urls.py
file.
This commit is contained in:
Hemanth V. Alluri
2019-06-30 22:46:33 +05:30
committed by Tim Abbott
parent f6aaf43029
commit e5cb3cabef
4 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
zproject/urls.py
View File

@@ -34,6 +34,7 @@ import zerver.views.muting
import zerver.views.streams
import zerver.views.realm
import zerver.views.digest
import zerver.views.messages
from zerver.context_processors import latest_info_context
import zerver.views.public_export