Ignoring elements

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

1 paths:
2   /users:
3     get:
4       x-fern-ignore: true
5       ...

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

1 components:
2   schemas:
3     SchemaToSkip:
4       x-fern-ignore: true
5       ...

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

1 components:
2   schemas:
3     User:
4       type: object
5       properties:
6         name:
7           type: string
8         internalField:
9           x-fern-ignore: true
10           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

1 paths:
2   /users:
3     get:
4       parameters:
5         - name: internalParam
6           in: query
7           x-fern-ignore: true
8           schema:
9             type: string

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

overrides.yml

1 paths:
2   /users:
3     get:
4       parameters:
5         - null  # Deletes the first parameter from base spec

1	components:
2	schemas:
3	User:
4	type: object
5	properties:
6	name:
7	type: string
8	internalField:
9	x-fern-ignore: true
10	type: string

1	paths:
2	/users:
3	get:
4	parameters:
5	- name: internalParam
6	in: query
7	x-fern-ignore: true
8	schema:
9	type: string