-
Notifications
You must be signed in to change notification settings - Fork 12
Open
Description
I tried out gendocs recently, and here's a wishlist of features I wish it had:
gendocsdoesn't list if a parameter is required or not (seems easy to add, since the information is there in DDA)gendocsdoesn't provide docs for members of JSON objectsgendocsdoesn't produce docs for responsesgendocsoutputs types with a Python repr, like<class 'str'>. This makes its output invalid JSON, and it would probably be more useful to output the JSON type anyway (rather than the Python type)gendocsdoesn't produce docs that span how to use the API, like "you need to follow up this API call with this other one". Maybe we could document the API this way, or maybe gendocs isn't the place for it.gendocsseems to addrequestas a field on every endpointgendocsgenerates different endpoint docs for "behaviorally routed" classes, but it doesn't specify how they're different - for example '"type" is the field that dispatches between these'gendocsdoesn't say / know if a field is deprecatedgendocsdoesn't say / know if a field or endpoint is "private" (so we could exclude it from the docs, optionally). Alternatively, we could have different doc "targets" (internal vs. external for example)- It would be nice if we could specify output formats (like Markdown)
gendocsdoesn't handle parameters inside JWTs
smholloway
Metadata
Metadata
Assignees
Labels
No labels