Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
43,222 Commits 28 Branches 143 Tags 627 MiB
Commit Graph

11 Commits

Author SHA1 Message Date
Tim Abbott c6f27440c6 openapi: Fix display for boolean example values. 
The comments explain in some detail, but basically we were displaying
the types for booleans incorrectly, and the types for strings in a
somewhat confusing fashion.  Fix this with comments explaining the logic.

Using JSON dumping also results in our showing strings inside
quotation marks in our examples, which seems net helpful.

Thanks to ArunSankarKs for finding where we needed to change the
codebase.

Fixes #18021.
 2021-04-07 09:52:42 -07:00
Suyash Vardhan Mathur 96bfeeb9e6 api docs: Expand checking for deprecated fields. 
Added assertion to check that if a deprecated flag is in a field's
schema, then it should have deprecated mentioned in description
as well, and moved these checks to a separate function.
Fixes part of #15967.
 2021-02-16 15:34:52 -08:00
Anders Kaseorg 6e4c3e41dc python: Normalize quotes with Black. 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
 2021-02-12 13:11:19 -08:00
Anders Kaseorg 11741543da python: Reformat with Black, except quotes. 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
 2021-02-12 13:11:19 -08:00
Suyash Vardhan Mathur c9c40d4fd2 api docs: Cleaned up CSS for parameter classes. 
Deduplicated CSS classes of data types of response and
request parameters in API Documentation to use a single
class.
 2021-02-09 10:31:36 -08:00
Suyash Vardhan Mathur f4cf5166bb api docs: Display data type of parameters in API documentation. 
Previously, the data type of parameters wasn't displayed in the API
Documentation, even though that OpenAPI data is carefully validated
against the implementation.  Here we add a recursive function to
render the data types visibly in the API documentation.

This only covers the request parameters; we'll want to do something
similar for response parameters in a follow-up PR.

Fixes part of #15967.
 2021-01-21 15:56:07 -08:00
Anders Kaseorg 4398eecd2b markdown: Use immutable type for extension config. 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
 2020-11-10 15:54:27 -08:00
Anders Kaseorg 254b904965 markdown: Migrate off deprecated extension registration interface. 
Fixes #15205.

https://python-markdown.github.io/change_log/release-3.0/#homegrown-ordereddict-has-been-replaced-with-a-purpose-built-registry
https://python-markdown.github.io/change_log/release-3.0/#md_globals-keyword-deprecated-from-extension-api

The priority numbers are arbitrarily chosen to preserve the existing
order.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
 2020-10-19 18:31:12 -07:00
Amitsinghyadav a72e9476ee api_docs: Add fragment references for all parameters. 
This makes it convenient to link to a specific parameter accepted by
Zulip API endpoint.
 2020-09-21 12:18:10 -07:00
Anders Kaseorg 1ded51aa9d python: Replace list literal concatenation with * unpacking. 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
 2020-09-02 11:15:41 -07:00
Mohit Gupta 3f5fc13491 refactor: Rename zerver.lib.bugdown to zerver.lib.markdown . 
This commit is first of few commita which aim to change all the
bugdown references to markdown. This commits rename the files,
file path mentions and change the imports.
Variables and other references to bugdown will be renamed in susequent
commits.
 2020-06-26 17:08:37 -07:00