Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions fern/products/api-def/openapi-pages/extensions/ignore.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Ignoring schemas or endpoints
description: Skip reading endpoints or schemas using the `x-fern-ignore` extension
title: Ignoring elements
description: Skip reading endpoints, schemas, or properties using the `x-fern-ignore` extension
---

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

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

Expand All @@ -24,3 +24,18 @@ components:
x-fern-ignore: true
...
```

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

```yaml title="x-fern-ignore at property level in openapi.yml" {9}
components:
schemas:
User:
type: object
properties:
name:
type: string
internalField:
x-fern-ignore: true
type: string
```