You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/docs/pages/getting-started/project-structure.mdx
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,10 +111,14 @@ title: Fern's Documentation
111
111
<AccordionGroup>
112
112
<Accordion title="OpenAPI">
113
113
The `openapi` folder contains the OpenAPI Specification file for your API Reference section. Fern will read either a YAML or JSON file from this folder to generate the API Reference documentation. If you don't have an API Reference section, you can skip this folder.
114
+
115
+
In addition to your specification file, you can optionally [add an overrides file](/api-definitions/overview/overrides) for additional customizations.
116
+
114
117
<CodeBlock title="fern/openapi">
115
118
```bash
116
119
openapi
117
-
└─ openapi.yaml # OR openapi.json
120
+
├─ openapi.yaml # OR openapi.json
121
+
└─ overrides.yaml
118
122
```
119
123
</CodeBlock>
120
124
@@ -123,12 +127,16 @@ title: Fern's Documentation
123
127
</Accordion>
124
128
<Accordion title="Fern Definition">
125
129
The `definition` folder contains the Fern Definition YAML files used to generate the API Reference section. If you don't have an API Reference section, you can skip this folder.
130
+
131
+
In addition to your specification file, you can optionally [add an overrides file](/api-definitions/overview/overrides) for additional customizations.
132
+
126
133
<CodeBlock title="fern/definition">
127
134
```bash
128
135
definition
129
136
├─ pets.yaml
130
137
├─ owners.yaml
131
138
├─ stores.yaml
139
+
├─ overrides.yaml
132
140
└─ api.yaml
133
141
```
134
142
</CodeBlock>
@@ -137,14 +145,18 @@ title: Fern's Documentation
137
145
138
146
</Accordion>
139
147
<Accordion title="Multiple APIs">
140
-
If you have multiple APIs, you can organize them into separate folders within the `apis` folder. Each API should have its own API definition. For example:
148
+
If you have multiple APIs, you can organize them into separate folders within the `apis` folder. Each API should have its own API definition and [(optional) overrides file](/api-definitions/overview/overrides).
0 commit comments