Skip to content

Commit

Permalink
(feature): Add pagination (IRv35) (#2985)
Browse files Browse the repository at this point in the history
  • Loading branch information
@amckinney
amckinney authored Feb 23, 2024
1 parent 463e91e commit eb1f59f
Show file tree
Hide file tree
Showing 83 changed files with 2,420 additions and 11 deletions.
10 changes: 10 additions & 0 deletions .pnp.cjs
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added .yarn/cache/@fern-fern-ir-v34-sdk-npm-0.0.8-e7e742818b-7ba15bd437.zip
View file
Binary file not shown.
24 changes: 24 additions & 0 deletions fern.schema.dev.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,30 @@
},
"additionalProperties": false
}
},
"pagination": {
"anyOf": [
{
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "The request property name that represents the page cursor or offset."
},
"next": {
"type": "string",
"description": "The response property name that represents the next page cursor or offset to retrieve."
},
"results": {
"type": "string",
"description": "The response property name that represents the page elements."
}
},
"required": ["page", "next", "results"],
"additionalProperties": false
},
{ "type": "boolean" }
]
}
},
"required": ["path"],
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/ete-tests/src/tests/dependencies/__snapshots__/dependencies.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,7 @@ exports[`dependencies correctly incorporates dependencies 1`] = `
"response": null,
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -770,4 +771,4 @@ exports[`dependencies correctly incorporates dependencies 1`] = `
}"
`;

exports[`dependencies file dependencies 1`] = `1412392`;
exports[`dependencies file dependencies 1`] = `1412752`;
17 changes: 17 additions & 0 deletions packages/cli/ete-tests/src/tests/ir/__snapshots__/ir.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1527,6 +1527,7 @@ exports[`ir {"name":"file-upload"} 1`] = `
"response": null,
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -7874,6 +7875,7 @@ exports[`ir {"name":"multiple-environment-urls"} 1`] = `
"response": null,
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
},
Expand Down Expand Up @@ -7920,6 +7922,7 @@ exports[`ir {"name":"multiple-environment-urls"} 1`] = `
"response": null,
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -8023,6 +8026,7 @@ exports[`ir {"name":"multiple-environment-urls"} 1`] = `
"response": null,
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -9764,6 +9768,7 @@ exports[`ir {"name":"nested-example-reference"} 1`] = `
"docs": null
}
],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -10495,6 +10500,7 @@ exports[`ir {"name":"packages"} 1`] = `
"response": null,
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -11806,6 +11812,7 @@ exports[`ir {"name":"response-property"} 1`] = `
},
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
},
Expand Down Expand Up @@ -11994,6 +12001,7 @@ exports[`ir {"name":"response-property"} 1`] = `
},
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -12906,6 +12914,7 @@ exports[`ir {"name":"simple","audiences":["internal"]} 1`] = `
}
],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -15388,6 +15397,7 @@ exports[`ir {"name":"simple","audiences":["test"]} 1`] = `
"docs": null
}
],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -22261,6 +22271,7 @@ exports[`ir {"name":"simple"} 1`] = `
}
],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
},
Expand Down Expand Up @@ -23567,6 +23578,7 @@ exports[`ir {"name":"simple"} 1`] = `
"docs": null
}
],
"pagination": null,
"availability": null,
"docs": null
},
Expand Down Expand Up @@ -25062,6 +25074,7 @@ exports[`ir {"name":"simple"} 1`] = `
"docs": null
}
],
"pagination": null,
"availability": null,
"docs": null
},
Expand Down Expand Up @@ -25401,6 +25414,7 @@ exports[`ir {"name":"simple"} 1`] = `
}
],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -25964,6 +25978,7 @@ exports[`ir {"name":"streaming"} 1`] = `
},
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
},
Expand Down Expand Up @@ -26136,6 +26151,7 @@ exports[`ir {"name":"streaming"} 1`] = `
},
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down Expand Up @@ -26785,6 +26801,7 @@ exports[`ir {"name":"variables"} 1`] = `
"response": null,
"errors": [],
"examples": [],
"pagination": null,
"availability": null,
"docs": null
}
Expand Down
1 change: 1 addition & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/api-wide-base-path.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ exports[`generate IR 1`] = `
"unsafeName": "post",
},
},
"pagination": null,
"path": {
"head": "/",
"parts": [
Expand Down
8 changes: 8 additions & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/api.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ exports[`generate IR 1`] = `
"unsafeName": "create_movie",
},
},
"pagination": null,
"path": {
"head": "/create-movie",
"parts": [],
Expand Down Expand Up @@ -774,6 +775,7 @@ exports[`generate IR 1`] = `
"unsafeName": "get_movie",
},
},
"pagination": null,
"path": {
"head": "/",
"parts": [
Expand Down Expand Up @@ -3382,6 +3384,7 @@ exports[`generate IR 3`] = `
"unsafeName": "foo",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down Expand Up @@ -3447,6 +3450,7 @@ exports[`generate IR 3`] = `
"unsafeName": "foo",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down Expand Up @@ -3590,6 +3594,7 @@ exports[`generate IR 3`] = `
"unsafeName": "foo",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down Expand Up @@ -3733,6 +3738,7 @@ exports[`generate IR 3`] = `
"unsafeName": "foo",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down Expand Up @@ -3838,6 +3844,7 @@ exports[`generate IR 3`] = `
"unsafeName": "endpoint",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down Expand Up @@ -3992,6 +3999,7 @@ exports[`generate IR 3`] = `
"unsafeName": "unknown_request",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down
2 changes: 2 additions & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/audiences.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ exports[`generate IR 1`] = `
"unsafeName": "get_direct_thread",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down Expand Up @@ -405,6 +406,7 @@ exports[`generate IR 1`] = `
"unsafeName": "find",
},
},
"pagination": null,
"path": {
"head": "",
"parts": [],
Expand Down
1 change: 1 addition & 0 deletions ...ges/cli/generation/ir-generator/src/__test__/__snapshots__/auth-environment-variables.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ exports[`generate IR 1`] = `
"unsafeName": "get_with_api_key",
},
},
"pagination": null,
"path": {
"head": "/apiKey",
"parts": [],
Expand Down
2 changes: 2 additions & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/basic-auth.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,7 @@ exports[`generate IR 1`] = `
"unsafeName": "get_with_basic_auth",
},
},
"pagination": null,
"path": {
"head": "/basic-auth",
"parts": [],
Expand Down Expand Up @@ -698,6 +699,7 @@ exports[`generate IR 1`] = `
"unsafeName": "post_with_basic_auth",
},
},
"pagination": null,
"path": {
"head": "/basic-auth",
"parts": [],
Expand Down
1 change: 1 addition & 0 deletions .../generation/ir-generator/src/__test__/__snapshots__/bearer-token-environment-variable.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ exports[`generate IR 1`] = `
"unsafeName": "get_with_bearer_token",
},
},
"pagination": null,
"path": {
"head": "/apiKey",
"parts": [],
Expand Down
1 change: 1 addition & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/bytes.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ exports[`generate IR 1`] = `
"unsafeName": "upload",
},
},
"pagination": null,
"path": {
"head": "/upload-content",
"parts": [],
Expand Down
2 changes: 2 additions & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/custom-auth.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,7 @@ exports[`generate IR 1`] = `
"unsafeName": "get_with_custom_auth",
},
},
"pagination": null,
"path": {
"head": "/custom-auth",
"parts": [],
Expand Down Expand Up @@ -686,6 +687,7 @@ exports[`generate IR 1`] = `
"unsafeName": "post_with_custom_auth",
},
},
"pagination": null,
"path": {
"head": "/custom-auth",
"parts": [],
Expand Down
4 changes: 4 additions & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/enum.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ exports[`generate IR 1`] = `
"unsafeName": "send",
},
},
"pagination": null,
"path": {
"head": "/inlined",
"parts": [],
Expand Down Expand Up @@ -665,6 +666,7 @@ exports[`generate IR 1`] = `
"unsafeName": "send",
},
},
"pagination": null,
"path": {
"head": "/path/",
"parts": [
Expand Down Expand Up @@ -936,6 +938,7 @@ exports[`generate IR 1`] = `
"unsafeName": "send",
},
},
"pagination": null,
"path": {
"head": "/query",
"parts": [],
Expand Down Expand Up @@ -1105,6 +1108,7 @@ exports[`generate IR 1`] = `
"unsafeName": "send_list",
},
},
"pagination": null,
"path": {
"head": "/query-list",
"parts": [],
Expand Down
1 change: 1 addition & 0 deletions packages/cli/generation/ir-generator/src/__test__/__snapshots__/error-property.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,7 @@ exports[`generate IR 1`] = `
"unsafeName": "throw_error",
},
},
"pagination": null,
"path": {
"head": "/property-based-error",
"parts": [],
Expand Down
Loading

0 comments on commit eb1f59f

Please sign in to comment.