Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How can I show schema description in tags using <SchemaDefinition /> #1840

Open
liaocyintl opened this issue Dec 22, 2021 · 0 comments
Open

Comments

@liaocyintl
Copy link

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?

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants