Redocly / Redocly/redoc

No description on schemas (e.g. response body schemas)

Open
#598 5 comments 25 reactions 1 assignee View on GitHub

@AntonKozachuk is already working on this.

Since Apr 12, 2021.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

ObjectSchema.tsx does not render schema description, even though the OpenAPI spec allows it, including using CommonMark in description:

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.