zulip/zerver/openapi
Lauryn Menard f755fd1a3a api-docs: Check for deprecated at top level of endpoint docs.
Previously, we had checked that deprecated parameters and return
values had been marked as `deprecated: true` in the OpenAPI
documentation and had a description with a deprecated note.

Here we extend that check at the top level to deprecated endpoints.

The backend test that catches a failed assertion for this check
is `test_api_doc_endpoints` in zerver/tests/test_docs.py as that
test checks for a success response all pages linked the sidebar of
the API documentation.
2023-10-25 12:21:53 -07:00
..
__init__.py openapi: Add missing __init__.py; fix type errors hidden by its absence. 2021-07-05 12:20:39 -07:00
curl_param_value_generators.py codespell: Fix typos caught by codespell. 2023-10-09 11:55:15 -07:00
javascript_examples.js message-type: Add support for "direct" as value for type parameter. 2023-04-18 12:29:33 -07:00
javascript_examples.py python: Replace universal_newlines with text. 2022-01-23 22:16:01 -08:00
markdown_extension.py mypy: Enable new error explicit-override. 2023-10-12 12:28:41 -07:00
openapi.py api-docs: Check for deprecated at top level of endpoint docs. 2023-10-25 12:21:53 -07:00
python_examples.py typing_indicator: Add a 'stream_id' parameter to 'POST /typing'. 2023-10-12 09:53:09 -07:00
test_curl_examples.py ruff: Fix PERF401 Use a list comprehension to create a transformed list. 2023-08-07 17:23:55 -07:00
testing.yaml test_openapi: Make testing.yml a full conformant specification. 2022-01-13 14:34:11 -08:00
zulip.yaml api-docs: Add deprecated true to /api/mute-topic endpoint. 2023-10-25 12:21:53 -07:00