Skip to content

Commit 0ba5859

Browse files
docs: Add documentation for x-fern-ignore at property level (#1498)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Niels Swimberghe <[email protected]>
1 parent fbde4ca commit 0ba5859

File tree

1 file changed

+18
-3
lines changed
  • fern/products/api-def/openapi-pages/extensions

1 file changed

+18
-3
lines changed

fern/products/api-def/openapi-pages/extensions/ignore.mdx

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Ignoring schemas or endpoints
3-
description: Skip reading endpoints or schemas using the `x-fern-ignore` extension
2+
title: Ignoring elements
3+
description: Skip reading endpoints, schemas, or properties using the `x-fern-ignore` extension
44
---
55

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

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

@@ -24,3 +24,18 @@ components:
2424
x-fern-ignore: true
2525
...
2626
```
27+
28+
To skip a property within a schema, add `x-fern-ignore: true` at the property level.
29+
30+
```yaml title="x-fern-ignore at property level in openapi.yml" {9}
31+
components:
32+
schemas:
33+
User:
34+
type: object
35+
properties:
36+
name:
37+
type: string
38+
internalField:
39+
x-fern-ignore: true
40+
type: string
41+
```

0 commit comments

Comments
 (0)