feat: add option to show the description when using the SchemaDefininition component

[osamu329]

What/Why/How?

This change allows show the description of schema definition..
I choose default value of showDescription is false, because it keep current behavior for existing using of the component.

The PR solves #1840.

If set showDescription={true} in following code, schema description is shown in tag related schema.
The PR doesn't include the change in following code.
However I expect that schema description is rendered when x-tags is specified.

redoc/src/services/MenuBuilder.ts

Line 278 in 11912f5

description: `<SchemaDefinition showWriteOnly={true} schemaRef="#/components/schemas/${schemaName}" />`,

Reference

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

Tests

Add some tests for SchemaDefinition.

Screenshots (optional)

OpenAPI spec for above screenshot

openapi: 3.1.0
info:
  title: SchemaDefinition showDescription demo.

tags:
  - name: Test1
    x-displayName: The Schema with description(showDescription=false)
    description: |
      <SchemaDefinition schemaRef="#/components/schemas/SchemaWithDescription" showExample={true} showDescription={false}/>
  - name: Test2
    x-displayName: The Schema with description(showDescription=true)
    description: |
      <SchemaDefinition schemaRef="#/components/schemas/SchemaWithDescription" showExample={false} showDescription={true}/>
  - name: Test3
    x-displayName: The Schema without description(showDescription=true)
    description: |
      <SchemaDefinition schemaRef="#/components/schemas/SchemaWithoutDescription" showExample={true} showDescription={true}/>

components:
  schemas:
    SchemaWithDescription:
      title: Schema with Description
      description: |
        ### Schema description

        ```js
        let pet = {id: "cat"}
        ```
      type: object
      properties:
        id:
          type: string

    SchemaWithoutDescription:
      title: Schema without description
      type: object
      properties:
        id:
          type: string

Check yourself

• Code is linted
• Tested
• All new/updated code is covered with tests

[equada-ew]

This would be extremely helpful.
Not sure who to contact - @AlexVarchuk since you participated in the original issue #1840 is there any chance to get this merged?