Home / Companies / Redocly / Blog / Post Details
Content Deep Dive

How to display schemas separately from operations in API docs?

Blog post from Redocly

Post Details
Company
Date Published
Author
Adam Altman
Word Count
448
Language
-
Hacker News Points
-
Summary

Redocly users have expressed a need for a more accessible "data dictionary" for API objects, as the current method of accessing schemas in OpenAPI is seen as cumbersome. The existing implementation is outdated and not user-friendly when displaying multiple schemas or organizing them effectively. To address this, two new approaches have been introduced in the Developer portal 1.1.0-beta.95. The first approach involves grouping all schemas together in a sidebar using the schemaDefinitionsTagName configuration in the Redocly configuration file, while the second approach allows schemas to be tagged with operations using the x-tags specification extension. These features allow for a more organized and accessible display of schemas, ensuring that they can be displayed either collectively or alongside relevant operations as needed.