Skip to content

Commit f7d9cc4

Browse files
devin-ai-integration[bot]dsinghvi
devin-ai-integration[bot]
and
dsinghvi
authored
feat(fdr): add includeInApiExplorer field to EndpointDefinition (#4790)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Deep Singhvi <[email protected]>
1 parent 779eb56 commit f7d9cc4

File tree

50 files changed

+6745
-3264
lines changed

Some content is hidden

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

50 files changed

+6745
-3264
lines changed

‎fern/apis/fdr/definition/api/latest/endpoint.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ types:
3939
examples: optional<list<ExampleEndpointCall>>
4040
snippetTemplates: optional<EndpointSnippetTemplates>
4141
protocol: optional<Protocol>
42+
includeInApiExplorer:
43+
type: optional<boolean>
44+
docs: Whether this endpoint should be included in the API explorer. Defaults to true.
4245

4346
Protocol:
4447
union:

‎fern/apis/fdr/definition/api/v1/db/endpoint.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ types:
3535
examples: list<readEndpoint.ExampleEndpointCall>
3636
snippetTemplates: optional<readEndpoint.EndpointSnippetTemplates>
3737
protocol: optional<commons.Protocol>
38+
includeInApiExplorer:
39+
type: optional<boolean>
40+
docs: Whether this endpoint should be included in the API explorer. Defaults to true.
3841

3942
DbHttpRequest:
4043
extends: commons.WithDescription

‎fern/apis/fdr/definition/api/v1/read/endpoint.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ types:
4040
examples: list<ExampleEndpointCall>
4141
snippetTemplates: optional<EndpointSnippetTemplates>
4242
protocol: optional<commons.Protocol>
43+
includeInApiExplorer:
44+
type: optional<boolean>
45+
docs: Whether this endpoint should be included in the API explorer. Defaults to true.
4346

4447
EndpointSnippetTemplates:
4548
properties:
@@ -326,4 +329,4 @@ types:
326329
type: string
327330
docs: |
328331
The client code that is generated by the fern compiler
329-
install: optional<string>
332+
install: optional<string>

‎fern/apis/fdr/definition/api/v1/register/endpoint.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ types:
4444
errorsV2: optional<list<ErrorDeclarationV2>>
4545
examples: list<ExampleEndpointCall>
4646
protocol: optional<commons.Protocol>
47+
includeInApiExplorer:
48+
type: optional<boolean>
49+
docs: Whether this endpoint should be included in the API explorer. Defaults to true.
4750

4851
EndpointPath:
4952
properties:

‎packages/fdr-sdk/src/__test__/output/airtop-dev/apiDefinitions.json‎

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,8 @@
260260
]
261261
}
262262
}
263-
}
263+
},
264+
"includeInApiExplorer": true
264265
},
265266
"endpoint_profiles.delete": {
266267
"id": "endpoint_profiles.delete",
@@ -476,7 +477,8 @@
476477
]
477478
}
478479
}
479-
}
480+
},
481+
"includeInApiExplorer": true
480482
},
481483
"endpoint_sessions.list": {
482484
"id": "endpoint_sessions.list",
@@ -1144,7 +1146,8 @@
11441146
]
11451147
}
11461148
}
1147-
}
1149+
},
1150+
"includeInApiExplorer": true
11481151
},
11491152
"endpoint_sessions.create": {
11501153
"id": "endpoint_sessions.create",
@@ -2041,7 +2044,8 @@
20412044
]
20422045
}
20432046
}
2044-
}
2047+
},
2048+
"includeInApiExplorer": true
20452049
},
20462050
"endpoint_sessions.getInfo": {
20472051
"id": "endpoint_sessions.getInfo",
@@ -2460,7 +2464,8 @@
24602464
"type": "generic"
24612465
}
24622466
}
2463-
}
2467+
},
2468+
"includeInApiExplorer": true
24642469
},
24652470
"endpoint_sessions.terminate": {
24662471
"id": "endpoint_sessions.terminate",
@@ -2676,7 +2681,8 @@
26762681
]
26772682
}
26782683
}
2679-
}
2684+
},
2685+
"includeInApiExplorer": true
26802686
},
26812687
"endpoint_windows.create": {
26822688
"id": "endpoint_windows.create",
@@ -3171,7 +3177,8 @@
31713177
]
31723178
}
31733179
}
3174-
}
3180+
},
3181+
"includeInApiExplorer": true
31753182
},
31763183
"endpoint_windows.get-window-info": {
31773184
"id": "endpoint_windows.get-window-info",
@@ -3651,7 +3658,8 @@
36513658
]
36523659
}
36533660
}
3654-
}
3661+
},
3662+
"includeInApiExplorer": true
36553663
},
36563664
"endpoint_windows.loadUrl": {
36573665
"id": "endpoint_windows.loadUrl",
@@ -4139,7 +4147,8 @@
41394147
]
41404148
}
41414149
}
4142-
}
4150+
},
4151+
"includeInApiExplorer": true
41434152
},
41444153
"endpoint_windows.close": {
41454154
"id": "endpoint_windows.close",
@@ -4450,7 +4459,8 @@
44504459
]
44514460
}
44524461
}
4453-
}
4462+
},
4463+
"includeInApiExplorer": true
44544464
},
44554465
"endpoint_windows.prompt-content": {
44564466
"id": "endpoint_windows.prompt-content",
@@ -5065,7 +5075,8 @@
50655075
]
50665076
}
50675077
}
5068-
}
5078+
},
5079+
"includeInApiExplorer": true
50695080
},
50705081
"endpoint_windows.scrape-content": {
50715082
"id": "endpoint_windows.scrape-content",
@@ -5572,7 +5583,8 @@
55725583
]
55735584
}
55745585
}
5575-
}
5586+
},
5587+
"includeInApiExplorer": true
55765588
},
55775589
"endpoint_windows.summarize-content": {
55785590
"id": "endpoint_windows.summarize-content",
@@ -6141,7 +6153,8 @@
61416153
]
61426154
}
61436155
}
6144-
}
6156+
},
6157+
"includeInApiExplorer": true
61456158
}
61466159
},
61476160
"websockets": {},

‎packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitions.json‎

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,8 @@
374374
]
375375
}
376376
}
377-
]
377+
],
378+
"includeInApiExplorer": true
378379
},
379380
"endpoint_transcripts.list": {
380381
"id": "endpoint_transcripts.list",
@@ -853,7 +854,8 @@
853854
]
854855
}
855856
}
856-
]
857+
],
858+
"includeInApiExplorer": true
857859
},
858860
"endpoint_transcripts.submit": {
859861
"id": "endpoint_transcripts.submit",
@@ -1986,7 +1988,8 @@
19861988
]
19871989
}
19881990
}
1989-
]
1991+
],
1992+
"includeInApiExplorer": true
19901993
},
19911994
"endpoint_transcripts.get": {
19921995
"id": "endpoint_transcripts.get",
@@ -3031,7 +3034,8 @@
30313034
]
30323035
}
30333036
}
3034-
]
3037+
],
3038+
"includeInApiExplorer": true
30353039
},
30363040
"endpoint_transcripts.delete": {
30373041
"id": "endpoint_transcripts.delete",
@@ -4076,7 +4080,8 @@
40764080
]
40774081
}
40784082
}
4079-
]
4083+
],
4084+
"includeInApiExplorer": true
40804085
},
40814086
"endpoint_transcripts.getSubtitles": {
40824087
"id": "endpoint_transcripts.getSubtitles",
@@ -4467,7 +4472,8 @@
44674472
]
44684473
}
44694474
}
4470-
]
4475+
],
4476+
"includeInApiExplorer": true
44714477
},
44724478
"endpoint_transcripts.getSentences": {
44734479
"id": "endpoint_transcripts.getSentences",
@@ -4897,7 +4903,8 @@
48974903
]
48984904
}
48994905
}
4900-
]
4906+
],
4907+
"includeInApiExplorer": true
49014908
},
49024909
"endpoint_transcripts.getParagraphs": {
49034910
"id": "endpoint_transcripts.getParagraphs",
@@ -5309,7 +5316,8 @@
53095316
]
53105317
}
53115318
}
5312-
]
5319+
],
5320+
"includeInApiExplorer": true
53135321
},
53145322
"endpoint_transcripts.wordSearch": {
53155323
"id": "endpoint_transcripts.wordSearch",
@@ -5709,7 +5717,8 @@
57095717
]
57105718
}
57115719
}
5712-
]
5720+
],
5721+
"includeInApiExplorer": true
57135722
},
57145723
"endpoint_transcripts.getRedactedAudio": {
57155724
"id": "endpoint_transcripts.getRedactedAudio",
@@ -6058,7 +6067,8 @@
60586067
]
60596068
}
60606069
}
6061-
]
6070+
],
6071+
"includeInApiExplorer": true
60626072
},
60636073
"endpoint_lemur.task": {
60646074
"id": "endpoint_lemur.task",
@@ -6448,7 +6458,8 @@
64486458
]
64496459
}
64506460
}
6451-
]
6461+
],
6462+
"includeInApiExplorer": true
64526463
},
64536464
"endpoint_lemur.summary": {
64546465
"id": "endpoint_lemur.summary",
@@ -6829,7 +6840,8 @@
68296840
]
68306841
}
68316842
}
6832-
]
6843+
],
6844+
"includeInApiExplorer": true
68336845
},
68346846
"endpoint_lemur.questionAnswer": {
68356847
"id": "endpoint_lemur.questionAnswer",
@@ -7276,7 +7288,8 @@
72767288
]
72777289
}
72787290
}
7279-
]
7291+
],
7292+
"includeInApiExplorer": true
72807293
},
72817294
"endpoint_lemur.actionItems": {
72827295
"id": "endpoint_lemur.actionItems",
@@ -7659,7 +7672,8 @@
76597672
]
76607673
}
76617674
}
7662-
]
7675+
],
7676+
"includeInApiExplorer": true
76637677
},
76647678
"endpoint_lemur.purgeRequestData": {
76657679
"id": "endpoint_lemur.purgeRequestData",
@@ -8005,7 +8019,8 @@
80058019
]
80068020
}
80078021
}
8008-
]
8022+
],
8023+
"includeInApiExplorer": true
80098024
},
80108025
"endpoint_realtime.createTemporaryToken": {
80118026
"id": "endpoint_realtime.createTemporaryToken",
@@ -8386,7 +8401,8 @@
83868401
]
83878402
}
83888403
}
8389-
]
8404+
],
8405+
"includeInApiExplorer": true
83908406
}
83918407
},
83928408
"websockets": {

0 commit comments

Comments
 (0)