Skip to content

Rendering of schema titles #626

@mol-pensiondk

Description

@mol-pensiondk

Titles from schemas are not rendered. I would expect them to be renderes as a title above the description (if any). According to the OpenAPI spec, the title property of schema elements are "as is" from JSON schema, i.e. it is supposed to be a one-line description of the schema. The description property is for longer descriptions (and may use MarkDown in OpenAPI - which the title may not!).

Screenshots are using the rapidoc js file from the playground (actual rendering) and from using a locally modified one from the PensionDanmark doc site (expected rendering).

The OpenAPI spec is "titles.json" (attached as titles.txt).

Expected rendering, inline schemas:
expected1
Actual rendering, inline schemas:
actual1

Expected rendering, schemas in components:
expected2
Actual rendering, schemas in components:
actual2

Expected rendering, schemas section:
expected3
Actual rendering, schemas section:
actual3

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions