Skip to content

Commit 9ab13da

Browse files
fern-api[bot]fern-api[bot]
committed
Release 0.0.91
1 parent 898ac73 commit 9ab13da

File tree

112 files changed

+7509
-564
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+7509
-564
lines changed

‎.mock/definition/algolia.yml

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
imports:
2+
commons: ./commons.yml
3+
apiReadV1Endpoint: ./api/v1/read/endpoint.yml
4+
navigation: ./navigation/__package__.yml
5+
types:
6+
AlgoliaSearchIndex: string
7+
Breadcrumbs: list<string>
8+
IndexSegmentId: string
9+
AlgoliaRecord:
10+
union:
11+
page-v3: AlgoliaPageRecordV3
12+
endpoint-v3: AlgoliaEndpointRecordV3
13+
websocket-v3: AlgoliaWebSocketRecordV3
14+
webhook-v3: AlgoliaWebhookRecordV3
15+
endpoint: AlgoliaEndpointRecord
16+
page: AlgoliaPageRecord
17+
endpoint-v2: AlgoliaEndpointRecordV2
18+
page-v2: AlgoliaPageRecordV2
19+
audiences:
20+
- read
21+
AlgoliaRecordVersionV3:
22+
properties:
23+
id: commons.VersionId
24+
slug: navigation.Slug
25+
AlgoliaPageRecordV3:
26+
properties:
27+
title: string
28+
content: optional<string>
29+
breadcrumbs: Breadcrumbs
30+
slug: navigation.Slug
31+
version: optional<AlgoliaRecordVersionV3>
32+
indexSegmentId: IndexSegmentId
33+
AlgoliaEndpointRecordV3:
34+
extends: AlgoliaPageRecordV3
35+
properties:
36+
method: apiReadV1Endpoint.HttpMethod
37+
endpointPath: list<apiReadV1Endpoint.EndpointPathPart>
38+
isResponseStream: optional<boolean>
39+
AlgoliaWebSocketRecordV3:
40+
extends: AlgoliaPageRecordV3
41+
properties:
42+
endpointPath: list<apiReadV1Endpoint.EndpointPathPart>
43+
AlgoliaWebhookRecordV3:
44+
extends: AlgoliaPageRecordV3
45+
properties:
46+
method: apiReadV1Endpoint.HttpMethod
47+
endpointPath: list<apiReadV1Endpoint.EndpointPathPart>
48+
IndexSegment:
49+
properties:
50+
id: IndexSegmentId
51+
searchApiKey: string
52+
SingleAlgoliaIndexInfo:
53+
union:
54+
unversioned: UnversionedSingleAlgoliaIndexInfo
55+
versioned: VersionedSingleAlgoliaIndexInfo
56+
UnversionedSingleAlgoliaIndexInfo:
57+
properties:
58+
indexSegment: IndexSegment
59+
VersionedSingleAlgoliaIndexInfo:
60+
properties:
61+
indexSegmentsByVersionId: map<commons.VersionId, IndexSegment>
62+
SearchInfo:
63+
union:
64+
legacyMultiAlgoliaIndex:
65+
type: LegacyMultiAlgoliaIndexInfo
66+
docs: >-
67+
The legacy search storage where each docs website got its own algolia
68+
index.
69+
singleAlgoliaIndex:
70+
type: SingleAlgoliaIndexInfo
71+
docs: Every docs website is indexed in a global Algolia Index
72+
LegacyMultiAlgoliaIndexInfo:
73+
properties:
74+
algoliaIndex: optional<string>
75+
availability: deprecated
76+
AlgoliaEndpointRecord:
77+
properties:
78+
title: string
79+
subtitle: string
80+
path: string
81+
version: optional<commons.VersionId>
82+
versionSlug: optional<string>
83+
indexSegmentId: optional<string>
84+
availability: deprecated
85+
AlgoliaPageRecord:
86+
properties:
87+
title: string
88+
subtitle: string
89+
path: string
90+
version: optional<commons.VersionId>
91+
versionSlug: optional<string>
92+
indexSegmentId: optional<string>
93+
availability: deprecated
94+
AlgoliaRecordEndpointPath:
95+
properties:
96+
parts: list<apiReadV1Endpoint.EndpointPathPart>
97+
availability: deprecated
98+
AlgoliaRecordPathPart:
99+
properties:
100+
name: string
101+
urlSlug: string
102+
skipUrlSlug: optional<boolean>
103+
availability: deprecated
104+
AlgoliaRecordPath:
105+
properties:
106+
parts: list<AlgoliaRecordPathPart>
107+
docs: >-
108+
The path corresponding to a search record represented as a list of parts.
109+
If the docs are versioned, the version prefix must be added when building
110+
the string representation of the path.
111+
availability: deprecated
112+
AlgoliaRecordEndpointSummary:
113+
properties:
114+
name: optional<string>
115+
description: optional<string>
116+
method: apiReadV1Endpoint.HttpMethod
117+
path: AlgoliaRecordEndpointPath
118+
availability: deprecated
119+
AlgoliaRecordVersion:
120+
properties:
121+
id: commons.VersionId
122+
urlSlug: string
123+
availability: deprecated
124+
AlgoliaEndpointRecordV2:
125+
properties:
126+
endpoint: AlgoliaRecordEndpointSummary
127+
path: AlgoliaRecordPath
128+
version: optional<AlgoliaRecordVersion>
129+
indexSegmentId: IndexSegmentId
130+
availability: deprecated
131+
AlgoliaPageRecordV2:
132+
properties:
133+
title: string
134+
content: string
135+
path: AlgoliaRecordPath
136+
version: optional<AlgoliaRecordVersion>
137+
indexSegmentId: IndexSegmentId
138+
availability: deprecated

‎.mock/definition/api.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
name: fern
2-
auth: bearer
3-
environments:
4-
Production: https://api.buildwithfern.com
5-
default-environment: Production
62
error-discrimination:
73
strategy: property
84
property-name: error
9-
audiences:
10-
- external
5+
audiences:
6+
- external
7+
environments:
8+
Production: https://api.buildwithfern.com
9+
default-environment: Production
10+
auth: bearer

‎.mock/definition/api/v1/db/__package__.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
imports:
2+
endpoint: endpoint.yml
3+
rootCommons: ../../../commons.yml
4+
readRoot: ../read/__package__.yml
5+
readType: ../read/type.yml
6+
readCommons: ../read/commons.yml
7+
readWebhook: ../read/webhook.yml
8+
readWebsocket: ../read/websocket.yml
9+
readEndpoint: ../read/endpoint.yml
10+
types:
11+
DbApiDefinition:
12+
properties:
13+
id: rootCommons.ApiDefinitionId
14+
rootPackage: DbApiDefinitionPackage
15+
types: map<readType.TypeId, readType.TypeDefinition>
16+
subpackages: map<readRoot.SubpackageId, DbApiDefinitionSubpackage>
17+
auth: optional<readRoot.ApiAuth>
18+
hasMultipleBaseUrls:
19+
type: boolean
20+
docs: |
21+
Whether or not endpoints are being served at different
22+
base urls (i.e. https://a.com and https://b.com)
23+
navigation:
24+
type: optional<readRoot.ApiNavigationConfigRoot>
25+
docs: Use the docs navigation instead.
26+
availability: deprecated
27+
globalHeaders: optional<list<readEndpoint.Header>>
28+
DbApiDefinitionPackage:
29+
properties:
30+
endpoints: list<endpoint.DbEndpointDefinition>
31+
websockets: optional<list<readWebsocket.WebSocketChannel>>
32+
webhooks: optional<list<readWebhook.WebhookDefinition>>
33+
types: list<readType.TypeId>
34+
subpackages: list<readRoot.SubpackageId>
35+
pointsTo:
36+
type: optional<readRoot.SubpackageId>
37+
docs: >
38+
if present, this package should be replaced with the provided
39+
subpackage
40+
41+
in the docs navigation.
42+
DbApiDefinitionSubpackage:
43+
extends:
44+
- readCommons.WithDescription
45+
- DbApiDefinitionPackage
46+
properties:
47+
parent: optional<readRoot.SubpackageId>
48+
subpackageId: readRoot.SubpackageId
49+
name: string
50+
urlSlug: string
51+
displayName: optional<string>

‎.mock/definition/api/v1/db/endpoint.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
imports:
2+
readCommons: ../read/commons.yml
3+
readEndpoint: ../read/endpoint.yml
4+
types:
5+
DbEndpointDefinition:
6+
extends: readCommons.WithDescription
7+
properties:
8+
authed: optional<boolean>
9+
availability: optional<readCommons.Availability>
10+
defaultEnvironment: optional<readEndpoint.EnvironmentId>
11+
environments: optional<list<readEndpoint.Environment>>
12+
method: readEndpoint.HttpMethod
13+
id: readEndpoint.EndpointId
14+
originalEndpointId: optional<string>
15+
urlSlug: string
16+
migratedFromUrlSlugs: optional<list<string>>
17+
name: optional<string>
18+
path: readEndpoint.EndpointPath
19+
queryParameters: list<readEndpoint.QueryParameter>
20+
headers: list<readEndpoint.Header>
21+
request: optional<DbHttpRequest>
22+
response: optional<readEndpoint.HttpResponse>
23+
errors: optional<list<readEndpoint.ErrorDeclaration>>
24+
errorsV2: optional<list<readEndpoint.ErrorDeclarationV2>>
25+
examples: list<readEndpoint.ExampleEndpointCall>
26+
snippetTemplates: optional<readEndpoint.EndpointSnippetTemplates>
27+
DbHttpRequest:
28+
extends: readCommons.WithDescription
29+
properties:
30+
contentType: optional<string>
31+
type: readEndpoint.HttpRequestBodyShape

‎.mock/definition/api/v1/read/__package__.yml

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
imports:
2+
endpoint: endpoint.yml
3+
type: type.yml
4+
rootCommons: ../../../commons.yml
5+
commons: commons.yml
6+
webhook: webhook.yml
7+
websocket: websocket.yml
8+
service:
9+
base-path: /registry/api
10+
auth: false
11+
endpoints:
12+
getApi:
13+
method: GET
14+
path: /load/{apiDefinitionId}
15+
path-parameters:
16+
apiDefinitionId: rootCommons.ApiDefinitionId
17+
response: ApiDefinition
18+
errors:
19+
- ApiDoesNotExistError
20+
audiences:
21+
- read
22+
types:
23+
ApiDefinition:
24+
properties:
25+
id: rootCommons.ApiDefinitionId
26+
rootPackage: ApiDefinitionPackage
27+
types: map<type.TypeId, type.TypeDefinition>
28+
subpackages: map<SubpackageId, ApiDefinitionSubpackage>
29+
auth: optional<ApiAuth>
30+
hasMultipleBaseUrls:
31+
type: optional<boolean>
32+
docs: |
33+
If empty, assume false.
34+
Whether or not endpoints are being served at different
35+
base urls (i.e. https://a.com and https://b.com)
36+
navigation:
37+
type: optional<ApiNavigationConfigRoot>
38+
docs: Use the docs navigation instead.
39+
availability: deprecated
40+
globalHeaders: optional<list<endpoint.Header>>
41+
ApiNavigationConfigRoot:
42+
properties:
43+
items: list<ApiNavigationConfigItem>
44+
ApiNavigationConfigItem:
45+
union:
46+
subpackage: ApiNavigationConfigSubpackage
47+
endpointId: endpoint.EndpointId
48+
websocketId: websocket.WebSocketId
49+
webhookId: webhook.WebhookId
50+
ApiNavigationConfigSubpackage:
51+
properties:
52+
subpackageId: SubpackageId
53+
items: list<ApiNavigationConfigItem>
54+
ApiDefinitionPackage:
55+
properties:
56+
endpoints: list<endpoint.EndpointDefinition>
57+
websockets: list<websocket.WebSocketChannel>
58+
webhooks: list<webhook.WebhookDefinition>
59+
types: list<type.TypeId>
60+
subpackages: list<SubpackageId>
61+
pointsTo:
62+
type: optional<SubpackageId>
63+
docs: >
64+
if present, this package should be replaced with the provided
65+
subpackage
66+
67+
in the docs navigation.
68+
ApiDefinitionSubpackage:
69+
extends:
70+
- commons.WithDescription
71+
- ApiDefinitionPackage
72+
properties:
73+
parent: optional<SubpackageId>
74+
subpackageId: SubpackageId
75+
name: string
76+
urlSlug: string
77+
displayName: optional<string>
78+
SubpackageId: string
79+
ApiAuth:
80+
union:
81+
bearerAuth: BearerAuth
82+
basicAuth: BasicAuth
83+
header: HeaderAuth
84+
BasicAuth:
85+
properties:
86+
usernameName: optional<string>
87+
passwordName: optional<string>
88+
BearerAuth:
89+
properties:
90+
tokenName: optional<string>
91+
HeaderAuth:
92+
properties:
93+
nameOverride: optional<string>
94+
headerWireValue: string
95+
prefix:
96+
type: optional<string>
97+
docs: The prefix that comes before the header
98+
errors:
99+
ApiDoesNotExistError:
100+
status-code: 404

‎.mock/definition/api/v1/read/commons.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
types:
2+
WithDescription:
3+
properties:
4+
description: optional<string>
5+
WithAvailability:
6+
properties:
7+
availability: optional<Availability>
8+
Availability:
9+
enum:
10+
- GenerallyAvailable
11+
- Deprecated
12+
- Beta

0 commit comments

Comments
 (0)