How can I show schema description in tags using <SchemaDefinition />
Open
Nobody has claimed this yet.
p3
Type: Enhancement
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
I define description in the components.schemas as follows:
components:
schemas:
some_schema:
title: some_schema
type: object
description: Some Description
properties:
param1:
title: param1
example: ''
type: string
Then I add the schema in tags:
tags:
- name: some_schema
x-displayName: some_schema
description: |
<SchemaDefinition schemaRef="#/components/schemas/some_schema" />
But the description: Some Description does not show on the webpage.
Is there any way to show the description?
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 at the entry point and trace how the referenced schema is rendered inside a tag description. Reproduce the sample components.schemas and tags configuration, then verify that “Some Description” appears on the generated webpage; the issue is complete when the schema description is displayed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100