Render object descriptions
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Consider the following response rendering (this is not related to the oneOf selectors, but they show that there are previously defined schema objects at play here):
In my definition, all the objects have a description. However, the description never seems to be rendered anywhere.
I suggest rendering the object's description wherever relevant, e.g. just above the property list shown in the screenshot.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the response renderer responsible for the schema object's property list shown in the issue and trace how object descriptions are handled. Done means an object's description appears in the relevant rendered response documentation, with the existing rendering behavior for oneOf selectors preserved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100