Skip to content

Property-level title keyword is silently dropped for OpenAPI 3.1 schemas #11053

Open

Description

@martins-spektors

Q&A (please complete the following information)

  • OS: All
  • Browser: All
  • Version: editor.swagger.io
  • Method of installation: None
  • Swagger-UI version: editor.swagger.io
  • Swagger/OpenAPI version: OpenAPI 3.0/3.1

Example Swagger/OpenAPI definition:

openapi: 3.1.0
info:
  title: Repro
  version: "1.0"
paths:
  /example:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              title: Example
              properties:
                plainField:
                  type: integer
                  format: int32
                  title: Only renders on OAS 3.0
                  description: Renders always.
                titledField:
                  type: integer
                  format: int32
                  title: Only renders on OAS 3.0
                  description: Renders always.
              required:
                - plainField
                - titledField
      responses:
        '200':
          description: OK

Describe the bug you're encountering

When a property inside an object schema has its own title keyword set, Swagger UI never renders it anywhere when the document is OpenAPI 3.1. The exact same schema, served as OpenAPI 3.0, renders the titles correctly.

To reproduce...

Steps to reproduce the behavior:

  1. Go to 'editor.swagger.io'
  2. Paste the example schema
  3. Compare title rendering (and lack thereof) between OAS 3.0 and 3.1

Expected behavior

A property's own title keyword should be displayed somewhere (as it is in the OAS 3.0).

Additional context or thoughts

This is distinct from the known $ref-sibling-keyword rendering (e.g., #9540) that changed in 3.1 due to stricter JSON schema adherence. There are zero $refs in the example, as the issue is entirely with property title rendering and has nothing to do with dereferencing.

Activity

  1. martins-spektors commented on Sep 17, 2026

    @martins-spektors
    Author

    Possible cause, looking at the source: KeywordTitle template has title={name}, which Properties.jsx always fills in with name={propertyName}, so that in Title.jsx renderedTitle = title || fn.getTitle(schema) always renders only the property name and never even looks at what the schema has.

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

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