-
Notifications
You must be signed in to change notification settings - Fork 138
/
docs.yml
558 lines (540 loc) · 20.4 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
instances:
- url: fern.docs.buildwithfern.com/learn
custom-domain: buildwithfern.com/learn
edit-this-page:
github:
owner: fern-api
repo: fern
branch: main
- url: fern.docs.dev.buildwithfern.com/learn
edit-this-page:
github:
owner: fern-api
repo: fern
branch: main
title: Fern
tabs:
home:
display-name: Home
icon: fa-regular fa-home
slug: home
api-definition:
display-name: API Definition
icon: fa-regular fa-book
slug: api-definition
docs:
display-name: Docs
icon: fa-regular fa-browser
slug: docs
sdks:
display-name: SDKs
icon: fa-brands fa-codepen
slug: sdks
cli-api:
display-name: CLI & API Reference
icon: fa-regular fa-code
slug: cli-api
css: ./assets/styles.css
redirects:
- source: /api-definition/fern/api-yml-reference
destination: /api-definition/fern/api-yml/overview
navigation:
- tab: home
layout:
- page: Welcome
path: pages/welcome.mdx
- tab: api-definition
layout:
- section: Introduction
contents:
- page: What is an API Definition?
icon: fa-regular fa-question-circle
path: ./pages/api-definition/introduction/what-is-an-api-definition.mdx
- page: What is the Fern Folder?
icon: fa-regular fa-folder
path: ./pages/api-definition/introduction/what-is-the-fern-folder.mdx
- section: OpenAPI Specification
slug: openapi
contents:
- page: Overview
icon: fa-regular fa-brackets-curly
path: ./pages/api-definition/openapi/overview.mdx
- page: Authentication
icon: fa-regular fa-lock-keyhole
path: ./pages/api-definition/openapi/auth.mdx
# - page: OpenAPI Examples
# icon: fa-regular fa-square-terminal
# path: ./pages/api-definition/openapi/examples.mdx
# slug: examples
- section: Endpoints
icon: fa-regular fa-object-intersect
slug: endpoints
contents:
- page: HTTP JSON Endpoints
icon: fa-regular fa-display-code
path: ./pages/api-definition/openapi/endpoints/rest.mdx
slug: http
- page: Multipart Form Uploads
icon: fa-regular fa-file
path: ./pages/api-definition/openapi/endpoints/multipart.mdx
slug: multipart
- page: Server Sent Events
path: ./pages/api-definition/openapi/endpoints/sse.mdx
icon: fa-regular fa-signal-stream
slug: sse
- page: Webhooks
path: ./pages/api-definition/openapi/webhooks.mdx
icon: fa-regular fa-webhook
- page: Audiences
icon: fa-duotone fa-users
path: ./pages/api-definition/openapi/extensions/audiences.mdx
slug: audiences
- section: Extensions
icon: fa-regular fa-object-intersect
slug: extensions
contents:
- page: SDK Method Names
icon: fa-regular fa-display-code
path: ./pages/api-definition/openapi/extensions/method-names.mdx
slug: method-names
- page: Parameter Names
icon: fa-regular fa-input-text
path: ./pages/api-definition/openapi/extensions/parameter-names.mdx
slug: parameter-names
- page: Other
icon: fa-regular fa-ellipsis-h
path: ./pages/api-definition/openapi/extensions/others.mdx
slug: others
- page: Overlay Customizations
icon: fa-regular fa-shuffle
path: ./pages/api-definition/openapi/overrides.mdx
- section: Integrate your Server Framework
icon: fa-regular fa-server
slug: frameworks
contents:
- page: FastAPI
icon: fa-regular fa-circle-bolt
path: ./pages/api-definition/openapi/server-frameworks/fastapi.mdx
slug: fastapi
- section: Fern Definition
slug: fern
contents:
- page: Overview
icon: fa-regular fa-seedling
path: ./pages/api-definition/fern-definition/overview.mdx
- page: Authentication
icon: fa-regular fa-lock-keyhole
path: ./pages/api-definition/fern-definition/auth.mdx
- page: Types
icon: fa-regular fa-shapes
path: ./pages/api-definition/fern-definition/types.mdx
- page: Endpoints
icon: fa-regular fa-plug
path: ./pages/api-definition/fern-definition/endpoints.mdx
- page: Webhooks
icon: fa-regular fa-webhook
path: ./pages/api-definition/fern-definition/webhooks.mdx
- page: Errors
icon: fa-regular fa-exclamation-triangle
path: ./pages/api-definition/fern-definition/errors.mdx
- page: Imports
icon: fa-regular fa-download
path: ./pages/api-definition/fern-definition/imports.mdx
- page: Examples
icon: fa-regular fa-square-terminal
path: ./pages/api-definition/fern-definition/examples.mdx
- page: Audiences
icon: fa-duotone fa-users
path: ./pages/api-definition/fern-definition/audiences.mdx
- page: Availability
icon: fa-regular fa-clock-rotate-left
path: ./pages/api-definition/fern-definition/availability.mdx
- section: api.yml Reference
icon: fa-regular fa-books
slug: api-yml
contents:
- page: Overview
icon: fa-regular fa-book
path: ./pages/api-definition/fern-definition/api-yml/overview.mdx
- page: Environments
icon: fa-regular fa-circle-wifi
path: ./pages/api-definition/fern-definition/api-yml/environments.mdx
- page: Global Headers
icon: fa-regular fa-globe
path: ./pages/api-definition/fern-definition/api-yml/global-configuration.mdx
- page: Errors
icon: fa-regular fa-exclamation-triangle
path: ./pages/api-definition/fern-definition/api-yml/errors.mdx
- page: Packages
icon: fa-regular fa-box-open
path: ./pages/api-definition/fern-definition/packages.mdx
- page: Depending on Other APIs
icon: fa-regular fa-link
path: ./pages/api-definition/fern-definition/depending-on-other-apis.mdx
- page: Export to OpenAPI
icon: fa-regular fa-file-export
slug: export-openapi
path: ./pages/api-definition/fern-definition/export-openapi.mdx
- tab: sdks
layout:
- section: Introduction
contents:
- page: Overview
path: ./pages/sdks/introduction/overview.mdx
- page: Configuration
path: ./pages/sdks/introduction/configuration.mdx
- section: Changelogs
slug: changelog
contents:
- changelog: ./pages/changelogs/python-sdk
title: Python
slug: python
- changelog: ./pages/changelogs/go-sdk
title: Go
slug: go
- changelog: ./pages/changelogs/csharp-sdk
title: .Net
slug: csharp
- changelog: ./pages/changelogs/java-sdk
title: Java
slug: java
- changelog: ./pages/changelogs/ruby-sdk
title: Ruby
slug: ruby
- section: Getting Started
contents:
- page: Generate your First SDK
path: ./pages/sdks/getting-started/generate-your-first-sdk.mdx
- page: Publish a Public-Facing SDK
path: ./pages/sdks/publish-sdk/publish-your-sdk.mdx
hidden: true
- section: Features
contents:
- page: Strongly Typed
path: ./pages/sdks/features/strongly-typed.mdx
- page: Idiomatic Method Names
path: ./pages/sdks/features/idiomatic-method-names.mdx
- page: Schema Validation
path: ./pages/sdks/features/schema-validation.mdx
- page: Discriminated Unions
path: ./pages/sdks/features/discriminated-unions.mdx
- page: Multipart Form Data
path: ./pages/sdks/features/multipart-form-data.mdx
- page: Forward Compatibility
path: ./pages/sdks/features/forward-compatibility.mdx
- page: Registry Publishing
path: ./pages/sdks/features/publish-to-registries.mdx
icon: fa-regular fa-pro
- page: Auto-Pagination
path: ./pages/sdks/features/auto-pagination.mdx
icon: fa-regular fa-pro
- page: OAuth Token Refresh
path: ./pages/sdks/features/oauth.mdx
icon: fa-regular fa-pro
- page: Retries with Backoff
path: ./pages/sdks/features/retries-with-backoff.mdx
icon: fa-regular fa-pro
- page: Webhook Signature Verification
path: ./pages/sdks/features/webhook-signature-verification.mdx
icon: fa-regular fa-pro
- page: Idempotency Headers
path: ./pages/sdks/features/idempotency-headers.mdx
icon: fa-regular fa-pro
- page: Server-Sent Events
path: ./pages/sdks/features/server-sent-events.mdx
icon: fa-regular fa-pro
- page: Integration Tests
path: ./pages/sdks/features/integration-tests.mdx
icon: fa-regular fa-pro
- page: Code Snippets
path: ./pages/sdks/features/code-snippets.mdx
icon: fa-regular fa-pro
- page: Augment with Custom Code
path: ./pages/sdks/features/augment-with-custom-code.mdx
icon: fa-regular fa-pro
- page: Merging Multiple APIs
path: ./pages/sdks/features/merging-multiple-apis.mdx
icon: fa-regular fa-pro
- page: WebSockets
path: ./pages/sdks/features/websockets.mdx
icon: fa-regular fa-pro
# icon: fa-regular fa-pro
# - page: Object oriented SDKs
# path: ./pages/sdks/features/dummy.mdx
# icon: fa-regular fa-pro
# - page: Polling
# path: ./pages/sdks/features/dummy.mdx
# icon: fa-regular fa-pro
# - page: GitHub integration
# path: ./pages/sdks/features/dummy.mdx
# icon: fa-regular fa-pro
- section: Package Managers
contents:
- page: NPM
path: ./pages/sdks/integration/npm.mdx
- page: PyPI
slug: pypi
path: ./pages/sdks/integration/pypi.mdx
- page: NuGet
slug: nuget
path: ./pages/sdks/integration/nuget.mdx
- page: Maven Central
slug: maven-central
path: ./pages/sdks/integration/maven-central.mdx
- section: Alternatives
hidden: true
contents:
- page: Speakeasy
path: ./pages/sdks/comparison/speakeasy.mdx
- tab: docs
layout:
- section: Getting Started
contents:
- page: Quickstart
slug: quickstart
path: ./pages/docs/getting-started/quickstart.mdx
icon: fa-regular fa-rocket
- page: Development
slug: development
path: ./pages/docs/getting-started/development.mdx
icon: fa-regular fa-terminal
- page: Global Configuration
slug: global-configuration
path: ./pages/docs/getting-started/global-configuration.mdx
icon: fa-regular fa-wrench
- page: Project Structure
slug: project-structure
path: ./pages/docs/getting-started/project-structure.mdx
icon: fa-regular fa-map
- section: Building Your Docs
contents:
- page: Navigation
icon: fa-regular fa-compass
path: ./pages/docs/building-your-docs/navigation.mdx
- page: Announcement Banner
icon: fa-regular fa-bullhorn
path: ./pages/docs/building-your-docs/announcement-banner.mdx
- page: Links and Redirects
icon: fa-regular fa-link
path: ./pages/docs/building-your-docs/links-and-redirects.mdx
- page: Customizing Slugs
icon: fa-regular fa-input-text
path: ./pages/docs/building-your-docs/customizing-slugs.mdx
- page: Hiding Content
icon: fa-regular fa-eye-slash
path: ./pages/docs/building-your-docs/hiding-content.mdx
- page: Custom CSS & Global JS
icon: fa-regular fa-paintbrush
path: ./pages/docs/building-your-docs/custom-css-js.mdx
- page: Pull Request Preview
icon: fa-regular fa-file-magnifying-glass
path: ./pages/docs/building-your-docs/pr-preview.mdx
- page: Custom Domain
icon: fa-regular fa-globe-pointer
path: ./pages/docs/building-your-docs/custom-domain.mdx
- page: Edit This Page and User Feedback
icon: fa-regular fa-comment
path: ./pages/docs/building-your-docs/user-feedback.mdx
- section: Writing Content
slug: content
contents:
- page: Write Markdown content
icon: fa-regular fa-font
path: ./pages/fern-docs/content/write-markdown.mdx
slug: write-markdown
- section: Components
icon: fa-regular fa-toolbox
slug: components
# path: ./pages/docs/components/overview.mdx
contents:
- page: Overview
icon: fa-regular fa-wrench
path: ./pages/docs/components/overview.mdx
- page: Accordions
path: ./pages/docs/components/accordions.mdx
slug: accordions
icon: "square-caret-down"
- page: Accordion Groups
path: ./pages/docs/components/accordion-groups.mdx
icon: table-rows
slug: accordion-groups
- page: Aside
path: ./pages/docs/components/asides.mdx
icon: align-right
slug: aside
- page: Callouts
path: ./pages/docs/components/callouts.mdx
icon: "circle-exclamation"
slug: callouts
- page: Cards
path: ./pages/docs/components/cards.mdx
icon: "rectangle"
slug: cards
- page: Card Groups
path: ./pages/docs/components/card-groups.mdx
icon: "rectangles-mixed"
slug: card-groups
- page: Code Blocks
path: ./pages/docs/components/code-blocks.mdx
slug: code-blocks
icon: "rectangle-code"
- page: Steps
path: ./pages/docs/components/steps.mdx
icon: "fa-solid fa-arrow-progress"
slug: steps
- page: Frames
path: ./pages/docs/components/frames.mdx
icon: "frame"
slug: frames
- page: Tabs
path: ./pages/docs/components/tabs.mdx
icon: "window-restore"
slug: tabs
- page: Endpoint Request Snippet
path: ./pages/docs/components/endpoint-request-snippet.mdx
icon: "turn-up"
slug: request-snippet
- page: Endpoint Response Snippet
path: ./pages/docs/components/endpoint-response-snippet.mdx
icon: "turn-down"
slug: response-snippet
- page: Frontmatter
icon: fa-regular fa-sliders
path: ./pages/fern-docs/content/front-matter.mdx
- page: Reusable Snippets
icon: fa-regular fa-recycle
path: ./pages/fern-docs/content/reusable-snippets.mdx
- page: Changelog
path: ./pages/docs/writing-content/changelog.mdx
icon: fa-regular fa-clock
- section: API References
contents:
- page: Generate API Reference
icon: fa-regular fa-gear-code
path: ./pages/fern-docs/content/generate-api-ref.mdx
slug: generate-api-ref
- page: SDK Snippets
icon: fa-regular fa-message-code
path: ./pages/fern-docs/config/sdk-snippets.mdx
- page: Endpoint Errors
icon: fa-regular fa-exclamation-triangle
path: ./pages/fern-docs/config/endpoint-errors.mdx
- page: Customize API Reference Layout
icon: fa-regular fa-arrow-up-arrow-down
path: ./pages/fern-docs/content/customize-api-ref.mdx
- page: Write Markdown in API Reference
icon: fa-regular fa-pencil
path: ./pages/fern-docs/content/api-ref-content.mdx
- page: Customize API Playground
icon: fa-regular fa-square-terminal
path: ./pages/fern-docs/content/customize-api-playground.mdx
- section: Integrations
slug: integrations
contents:
- page: Overview
icon: fa-regular fa-link
slug: overview
path: ./pages/docs/integrations/overview.mdx
- section: Analytics
icon: fa-regular fa-chart-simple
slug: analytics
contents:
- page: PostHog
path: ./pages/docs/integrations/analytics/posthog.mdx
slug: posthog
- page: Fullstory
path: ./pages/docs/integrations/analytics/fullstory.mdx
- page: Segment
path: ./pages/docs/integrations/analytics/segment.mdx
- section: Support
icon: fa-regular fa-headset
slug: support
contents:
- page: Intercom
path: ./pages/docs/integrations/support/intercom.mdx
- page: Postman
slug: postman
path: ./pages/docs/integrations/postman.mdx
- section: Developer Tools
contents:
- page: GitLab
slug: gitlab
icon: fa-brands fa-gitlab
path: ./pages/docs/developer-tools/gitlab.mdx
- page: Vale
icon: fa-regular fa-list-check
path: ./pages/docs/developer-tools/vale.mdx
- section: Alternatives
hidden: true
contents:
- page: ReadMe
slug: readme
path: ./pages/docs/comparison/readme.mdx
- tab: cli-api
layout:
- section: CLI Reference
contents:
- page: CLI Overview
path: ./pages/cli-api/overview.mdx
- page: Global Options
path: ./pages/cli-api/global-options.mdx
- page: Commands
path: ./pages/cli-api/commands.mdx
- changelog: ./pages/changelogs/cli
- api: API Reference
api-name: public-api
summary: ./pages/cli-api/api-summary.mdx
paginated: true
audiences:
- external
layout:
- page: Overview
path: ./pages/cli-api/api-summary.mdx
# snippets:
# python: fern-api
# typescript: "@fern-api/node-sdk"
navbar-links:
- type: minimal
text: Join our community
url: https://join.slack.com/t/fern-community/shared_invite/zt-2q7ev4mki-mhO5anKslwRowp4oExWf4A
- type: filled
text: Book a demo
url: https://buildwithfern.com/contact
typography:
bodyFont:
name: GT-Planar
path: ./assets/GT-Planar.woff2
weight: 400
headingsFont:
name: GT-Planar
path: ./assets/GT-Planar-Bold.woff2
logo:
href: https://www.buildwithfern.com
light: ./images/logo-primary.svg
dark: ./images/logo-white.svg
height: 30
# background-image:
# dark: ./images/background.svg
colors:
accentPrimary:
dark: "#1DA32B"
light: "#1DA32B"
background:
dark: "#081008"
light: "#FBFFFA"
header-background:
dark: "#081008"
light: "#FBFFFA"
favicon: ./images/favicon.ico
layout:
page-width: 1504px
header-height: 75px
searchbar-placement: header
tabs-placement: header
js:
- url: https://guidebar-backend-727ab3a68ba9.herokuapp.com/install/buildwithfern_com
- ./js/koala.js
- ./js/rbtob.js
analytics:
posthog:
api-key: ${POSTHOG_API_KEY}