Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(feat): refactor how pagination properties are checked in fern check #4250

Merged
merged 17 commits into from
Aug 10, 2024
Merged

(feat): refactor how pagination properties are checked in fern check #4250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
87755cc
add next page property to ir
dsinghvi Aug 9, 2024
1d58aa9
fix
dsinghvi Aug 9, 2024
486db69
add test definition
dsinghvi Aug 9, 2024
cd0a5b7
(feat, python): move to ruff for formatting (#4219)
dsinghvi Aug 9, 2024
e4e374b
pr feedback
dsinghvi Aug 9, 2024
8559adc
fix
dsinghvi Aug 9, 2024
5a9c4c8
try again
dsinghvi Aug 9, 2024
3256303
fix
dsinghvi Aug 9, 2024
bec635f
fix
dsinghvi Aug 9, 2024
5140139
fix has next page
dsinghvi Aug 10, 2024
16e46f2
fix ci related to has next page
dsinghvi Aug 10, 2024
59c01a8
fix
dsinghvi Aug 10, 2024
0bd2518
copy origin main
dsinghvi Aug 10, 2024
7657247
fix
dsinghvi Aug 10, 2024
9c71c05
fix ci
dsinghvi Aug 10, 2024
720f84a
json schema
dsinghvi Aug 10, 2024
d1bf800
fix missed ete tests
dsinghvi Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern.schema.dev.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -839,6 +839,10 @@
"step": {
"type": "string",
"description": "The path to the request property for the page step."
},
"has-next-page": {
"type": "string",
"description": "The path to the response property indicating next page presence."
}
},
"required": ["offset", "results"],
Expand Down
4 changes: 4 additions & 0 deletions fern.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -839,6 +839,10 @@
"step": {
"type": "string",
"description": "The path to the request property for the page step."
},
"has-next-page": {
"type": "string",
"description": "The path to the response property indicating next page presence."
}
},
"required": ["offset", "results"],
Expand Down
13 changes: 12 additions & 1 deletion packages/cli/docs-resolver/src/__test__/__snapshots__/api-resolver.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000.deleteMovie",
"isResponseStream": false,
"method": "DELETE",
"playground": undefined,
"slug": "base/path/api-reference/testing/delete-movie",
"title": "Delete Movie",
"type": "endpoint",
Expand All @@ -32,6 +33,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000.getMovie",
"isResponseStream": false,
"method": "GET",
"playground": undefined,
"slug": "base/path/api-reference/testing/get-movie",
"title": "Get Movie",
"type": "endpoint",
Expand All @@ -42,6 +44,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000.testing",
"noindex": undefined,
"overviewPageId": undefined,
"playground": undefined,
"pointsTo": "base/path/api-reference/testing/delete-movie",
"slug": "base/path/api-reference/testing",
"title": "Testing",
Expand All @@ -64,6 +67,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.createTrailer",
"isResponseStream": false,
"method": "POST",
"playground": undefined,
"slug": "base/path/api-reference/imdb/trailers/create-trailer",
"title": "Create Trailer",
"type": "endpoint",
Expand All @@ -77,6 +81,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.getTrailer",
"isResponseStream": false,
"method": "GET",
"playground": undefined,
"slug": "base/path/api-reference/imdb/trailers/get-trailer",
"title": "Get Trailer",
"type": "endpoint",
Expand All @@ -90,6 +95,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.getTrailerForMovie",
"isResponseStream": false,
"method": "GET",
"playground": undefined,
"slug": "base/path/api-reference/imdb/trailers/get-trailer-for-movie",
"title": "Get Trailer For Movie",
"type": "endpoint",
Expand All @@ -103,6 +109,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.deleteTrailer",
"isResponseStream": false,
"method": "DELETE",
"playground": undefined,
"slug": "base/path/api-reference/imdb/trailers/delete-trailer",
"title": "Delete Trailer",
"type": "endpoint",
Expand All @@ -113,6 +120,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000.subpackage_imdb.subpackage_trailers",
"noindex": undefined,
"overviewPageId": undefined,
"playground": undefined,
"pointsTo": "base/path/api-reference/imdb/trailers/create-trailer",
"slug": "base/path/api-reference/imdb/trailers",
"title": "Trailers",
Expand All @@ -127,6 +135,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_imdb.createMovie",
"isResponseStream": false,
"method": "POST",
"playground": undefined,
"slug": "base/path/api-reference/imdb/create-movie",
"title": "Create Movie",
"type": "endpoint",
Expand All @@ -137,19 +146,21 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000.subpackage_imdb",
"noindex": undefined,
"overviewPageId": undefined,
"playground": undefined,
"pointsTo": "base/path/api-reference/imdb/trailers/create-trailer",
"slug": "base/path/api-reference/imdb",
"title": "Imdb",
"type": "apiPackage",
},
],
"disableLongScrolling": false,
"hidden": undefined,
"hideTitle": false,
"icon": undefined,
"id": "550e8400-e29b-41d4-a716-446655440000",
"noindex": undefined,
"overviewPageId": undefined,
"paginated": false,
"playground": undefined,
"pointsTo": "base/path/api-reference/testing/delete-movie",
"showErrors": false,
"slug": "base/path/api-reference",
Expand Down
8 changes: 7 additions & 1 deletion packages/cli/docs-resolver/src/__test__/__snapshots__/stream.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_stream.createChatCompletion",
"isResponseStream": false,
"method": "POST",
"playground": undefined,
"slug": "base/path/api-reference/stream/create-chat-completion",
"title": "Create Chat Completion",
"type": "endpoint",
Expand All @@ -34,6 +35,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_stream.createChatCompletion_stream",
"isResponseStream": true,
"method": "POST",
"playground": undefined,
"slug": "base/path/api-reference/stream/create-chat-completion-stream",
"title": "Create Chat Completion",
"type": "endpoint",
Expand All @@ -51,6 +53,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_stream.createCompletion",
"isResponseStream": false,
"method": "POST",
"playground": undefined,
"slug": "base/path/api-reference/stream/create-completion",
"title": "Create Completion",
"type": "endpoint",
Expand All @@ -64,6 +67,7 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:endpoint_stream.createCompletion_stream",
"isResponseStream": true,
"method": "POST",
"playground": undefined,
"slug": "base/path/api-reference/stream/create-completion-stream",
"title": "Create Completion",
"type": "endpoint",
Expand All @@ -76,19 +80,21 @@ exports[`converts to api reference node 1`] = `
"id": "550e8400-e29b-41d4-a716-446655440000:subpackage_stream",
"noindex": undefined,
"overviewPageId": undefined,
"playground": undefined,
"pointsTo": "base/path/api-reference/stream/create-chat-completion",
"slug": "base/path/api-reference/stream",
"title": "Stream",
"type": "apiPackage",
},
],
"disableLongScrolling": false,
"hidden": undefined,
"hideTitle": false,
"icon": undefined,
"id": "550e8400-e29b-41d4-a716-446655440000",
"noindex": undefined,
"overviewPageId": undefined,
"paginated": false,
"playground": undefined,
"pointsTo": "base/path/api-reference/stream/create-chat-completion",
"showErrors": false,
"slug": "base/path/api-reference",
Expand Down
Loading
Loading