-
Notifications
You must be signed in to change notification settings - Fork 44
feat: add apify api subcommand for direct API access
#1076
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.
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
Open
patrikbraborec
wants to merge
5
commits into
master
Choose a base branch
from
feat/apify-api-subcommand
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e862e2b
feat: add `apify api` subcommand for direct API access
patrikbraborec 82cee5d
fix: address review issues in `apify api` subcommand
patrikbraborec 99957ac
fix: improve `apify api` with positional method, auto v2 prefix, quer…
patrikbraborec 3ab62dd
fix: harden apify api command and add local test coverage
patrikbraborec 735090e
fix: reset-per-test log buffer in api tests to avoid stale spy calls
patrikbraborec File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /** | ||
| * Fetches the Apify OpenAPI spec and extracts a minimal endpoint catalog | ||
| * (method, path, summary) for use by the `apify api --list-endpoints` flag. | ||
| */ | ||
|
|
||
| import { writeFile } from 'node:fs/promises'; | ||
|
|
||
| const OPENAPI_URL = 'https://docs.apify.com/api/openapi.json'; | ||
| const OUTPUT_PATH = new URL('../src/commands/api-endpoints.json', import.meta.url); | ||
|
|
||
| interface OpenAPISpec { | ||
| paths: Record<string, Record<string, { summary?: string }>>; | ||
| } | ||
|
|
||
| interface Endpoint { | ||
| method: string; | ||
| path: string; | ||
| summary: string; | ||
| } | ||
|
|
||
| const HTTP_METHODS = new Set(['get', 'post', 'put', 'patch', 'delete']); | ||
|
|
||
| console.log(`Fetching OpenAPI spec from ${OPENAPI_URL}...`); | ||
|
|
||
| const response = await fetch(OPENAPI_URL); | ||
|
|
||
| if (!response.ok) { | ||
| throw new Error(`Failed to fetch OpenAPI spec: ${response.status} ${response.statusText}`); | ||
| } | ||
|
|
||
| const spec = (await response.json()) as OpenAPISpec; | ||
|
|
||
| const endpoints: Endpoint[] = []; | ||
|
|
||
| for (const [path, methods] of Object.entries(spec.paths)) { | ||
| for (const [method, details] of Object.entries(methods)) { | ||
| if (HTTP_METHODS.has(method)) { | ||
| endpoints.push({ | ||
| method: method.toUpperCase(), | ||
| path, | ||
| summary: details.summary || '', | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Sort by path, then method | ||
| endpoints.sort((a, b) => a.path.localeCompare(b.path) || a.method.localeCompare(b.method)); | ||
|
|
||
| await writeFile(OUTPUT_PATH, `${JSON.stringify(endpoints, null, '\t')}\n`); | ||
|
|
||
| console.log(`Extracted ${endpoints.length} endpoints to ${OUTPUT_PATH.pathname}`); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Failing to fetch this should prevent building!! Also i would NOT bundle this in our code but rather download it on demand when listing endpoints