Skip to content

Commit 2322dc4

Browse files
authored
feat: add v2Responses object to v1 EndpointDefinition type (#3275)
1 parent a73c741 commit 2322dc4

File tree

25 files changed

+259
-1
lines changed

25 files changed

+259
-1
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ types:
2525
headers: list<readEndpoint.Header>
2626
request: optional<DbHttpRequest>
2727
response: optional<readEndpoint.HttpResponse>
28+
responsesV2: optional<readEndpoint.HttpResponsesV2>
2829
errors: optional<list<readEndpoint.ErrorDeclaration>>
2930
errorsV2: optional<list<readEndpoint.ErrorDeclarationV2>>
3031
examples: list<readEndpoint.ExampleEndpointCall>

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ types:
2828
headers: list<Header>
2929
request: optional<HttpRequest>
3030
response: optional<HttpResponse>
31+
responsesV2: optional<HttpResponsesV2>
3132
errors:
3233
type: list<ErrorDeclaration>
3334
availability: deprecated
@@ -100,6 +101,10 @@ types:
100101
type: optional<integer>
101102
docs: Defaults to 200
102103

104+
HttpResponsesV2:
105+
properties:
106+
responses: optional<list<HttpResponse>>
107+
103108
JsonBodyShape:
104109
union:
105110
object: type.ObjectType

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ types:
3333
headers: list<Header>
3434
request: optional<HttpRequest>
3535
response: optional<HttpResponse>
36+
responsesV2: optional<HttpResponsesV2>
3637
errors:
3738
type: optional<list<ErrorDeclaration>>
3839
availability: deprecated
@@ -113,6 +114,10 @@ types:
113114
statusCode:
114115
type: optional<integer>
115116
docs: Defaults to 200
117+
118+
HttpResponsesV2:
119+
properties:
120+
responses: optional<list<HttpResponse>>
116121

117122
ErrorDeclaration:
118123
extends:

packages/fdr-sdk/src/api-definition/migrators/v1ToV2.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,17 @@ export class ApiDefinitionV1ToLatest {
212212
requestHeaders: this.migrateParameters(v1.headers),
213213
responseHeaders: undefined,
214214
requests: [this.migrateHttpRequest(v1.request)].filter(isNonNullish),
215-
responses: [this.migrateHttpResponse(v1.response)].filter(isNonNullish),
215+
responses: (() => {
216+
const responses = v1.responsesV2?.responses
217+
?.map((response) => this.migrateHttpResponse(response))
218+
?.filter(isNonNullish);
219+
220+
if (responses != null && responses.length > 0) {
221+
return responses;
222+
}
223+
224+
return [this.migrateHttpResponse(v1.response)].filter(isNonNullish);
225+
})(),
216226
errors: this.migrateHttpErrors(v1.errorsV2),
217227
examples: undefined,
218228
snippetTemplates: v1.snippetTemplates,

packages/fdr-sdk/src/client/generated/api/resources/api/resources/v1/resources/db/resources/endpoint/types/DbEndpointDefinition.ts

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/fdr-sdk/src/client/generated/api/resources/api/resources/v1/resources/read/resources/endpoint/types/EndpointDefinition.ts

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/fdr-sdk/src/client/generated/api/resources/api/resources/v1/resources/read/resources/endpoint/types/HttpResponsesV2.ts

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/fdr-sdk/src/client/generated/api/resources/api/resources/v1/resources/read/resources/endpoint/types/index.ts

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/fdr-sdk/src/client/generated/api/resources/api/resources/v1/resources/register/resources/endpoint/types/EndpointDefinition.ts

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/fdr-sdk/src/client/generated/api/resources/api/resources/v1/resources/register/resources/endpoint/types/HttpResponsesV2.ts

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)