Tag display names (OpenAPI) | Fern Documentation

By default, tag names from your OpenAPI specification become section names in your API Reference. Use the x-displayName extension to control how these section names display in your generated documentation. This is helpful for controlling capitalization and creating user-friendly names.

Define tags with display names at the root level of your OpenAPI specification, then reference them by name in your operations:

openapi.yml

openapi: 3.0.0
info:
  title: Plant Care API
  version: 1.0.0
tags:
  - name: plant
    x-displayName: Plants
    description: Operations for managing plants
  - name: watering-schedule
    x-displayName: Watering Schedules
    description: Handle watering schedule operations
paths:
  /plants:
    get:
      tags:
        - plant
      summary: List all plants
  /plants/{plantId}:
    get:
      tags:
        - plant
      summary: Get a plant by ID
  /watering-schedules:
    get:
      tags:
        - watering-schedule
      summary: List watering schedules

You can also set display names in an overrides file.

Alternatively, you can rename sections directly in your docs.yml file.