-
Couldn't load subscription status.
- Fork 9
Description
Is your feature request related to a problem? Please describe.
I started to use the mermaid sequence diagram a lot to describe APIs and what flows are possible by combining different possible options, like (e.g. first you call the signin API, then you call the edit profile API, then you use the add content API, etc...)
Describe the solution you'd like
I have already markdown documents which describe my API
I also have sequence diagram which describe ROLES and how they use the API to interact with the system using certain interaction flows.
I'd like to add a real hyperlink in the description of my sequence diagram, so that i can use the specific API methods they use and users can click to jump to the API docs to see exactly how that API method works.
Describe alternatives you've considered
I currently just mark each entry in the sequence diagram with (e.g. #1, #2 ,#3, ....) and then I have a bullet point list after the sequence diagram to list the involved API's, but that makes it harder to read, more verbose and less convenient.
I want users to be able to click directly on a specific element of the sequence diagram to hyper-jump to the API documentation section :-)