Ability to link directly to fields within response schema in API documentation
backlog
V
Vijay Sakthivel
Currently, Document360 allows linking to headings across workspaces, including within API documentation; however, it is not possible to link directly to specific fields within an endpoint’s response schema (such as nested properties). The customer requires the ability to create direct links from documentation, to individual fields within the response schema.
At present, since schema fields are dynamically generated from the API specification, they cannot be individually referenced, which limits navigation. Enabling anchor links for response schema fields would significantly improve usability, allowing users to directly navigate to precise fields and making documentation more scalable for teams managing frequently updated APIs.
Log In
D
D360 Product Management
marked this post as
backlog
Pavithra Mathivanan
Hi Heliotrope Koala, Thank you for sharing this use case, we understand the need to deep link directly to specific fields within response schemas, especially for complex and frequently updated APIs.
At the moment, since these fields are dynamically generated from the API specification, they are not individually referenceable. However, we do see the value this would bring in improving navigation and usability.
We will evaluate this further and, based on traction and priority, work towards incorporating it into our roadmap.
V
Vijay Sakthivel
Raised on behalf of Heliotrope Koala