Add the option to create Callouts in API Docs
backlog
W
Willing Toucan
Add the option for "Callouts" (add Note / Warning / Error) sections in the API reference documentation
Log In
D
D360 Product Management
marked this post as
backlog
D
D360 Product Management
Merged in a post:
Enhanced Formatting Options in API Documentation
Akash Sivaraman
Introduce formatting options and editing tools in the API Documentation section, similar to those available in regular documentation pages.
Currently, API Documentation does not provide the same rich text formatting capabilities available in standard documentation.
Authors are unable to:
-> Apply advanced text formatting (headings, emphasis, alignment)
-> Insert structured content such as tables
->Add callouts, notes, or warning blocks
-> Embed formatted code examples consistently
->Maintain visual consistency with regular documentation
Akash Sivaraman
+ Quicksilver Pheasant
V
Vermilion Crow
I also have a use case for adding callouts to the API doc. To add additional information or warnings for certain endpoints.
M
Magnificent Grasshopper
Willing Toucan thanks for sharing your idea of having to include callouts within the same. Though it is a straightforward ask, but as standard format API references usually would have a description that would convey the developer to understand the details but having a callout is like an error or info message. With regards to API you would be having response codes and the descriptions right?
W
Willing Toucan
Magnificent Grasshopper Callout is more for Tips & Tricks or Notes, we are using today the callouts in other platform and it is helping us explain better use cases for our customers