Ignoring elements (OpenAPI) | Fern Documentation

If you want Fern to skip reading any endpoints, schemas, properties, or parameters, use the x-fern-ignore extension.

Ignore an endpoint

To skip an endpoint, add x-fern-ignore: true at the operation level.

x-fern-ignore at operation level in openapi.yml

paths:
  /users:
    get:
      x-fern-ignore: true
      ...

Ignore a schema

To skip a schema, add x-fern-ignore: true at the schema level.

x-fern-ignore at schema level in openapi.yml

components:
  schemas:
    SchemaToSkip:
      x-fern-ignore: true
      ...

Ignore a property

To skip a property within a schema, add x-fern-ignore: true at the property level.

x-fern-ignore at property level in openapi.yml

components:
  schemas:
    User:
      type: object
      properties:
        name:
          type: string
        internalField:
          x-fern-ignore: true
          type: string

Ignore a parameter

To skip a parameter, add x-fern-ignore: true at the parameter level.

x-fern-ignore at parameter level in openapi.yml

paths:
  /users:
    get:
      parameters:
        - name: internalParam
          in: query
          x-fern-ignore: true
          schema:
            type: string

To skip a parameter without modifying your base spec, use null values in your overrides file to delete parameters:

overrides.yml

paths:
  /users:
    get:
      parameters:
        - null  # Deletes the first parameter from base spec