feat: add OpenAPI 3.0 specification generator #29
Conversation
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
- Create programmatic OpenAPI spec generator that derives documentation from existing type definitions - Add parameter metadata for all 31 query parameters with descriptions, examples, and validation constraints - Add response schemas for VerboseResult, ErrorResponse, and nested types - Generate openapi.json as part of build process - Document compatibility with ScrapingBee, ScrapingAnt, and ScraperAPI parameters - Fix js_scenario schema to match actual implementation format (action as key, param as value) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
npm automatically adds node_modules/.bin to PATH when running scripts, so npx is not needed for locally installed packages. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Prevents API tools from pre-populating boolean parameters that default to false. Keeps meaningful defaults like render_js=true, timeout=140000. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Only url remains required, all other parameters are optional with no defaults. This prevents API tools from pre-populating any fields. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
openapi.jsonas part of the build processImplementation Details
src/openapi/parameter-metadata.ts: Metadata for each query parameter (descriptions, examples, validation)src/openapi/response-schemas.ts: OpenAPI schemas derived fromtypes.tssrc/openapi/types.ts: TypeScript interfaces for OpenAPI objectsscripts/generate-openapi.ts: Generator script that produces the complete specopenapi.json: Generated OpenAPI 3.0.3 specification (auto-generated on build)Test Plan
npm run generate:openapito verify generator worksopenapi.jsonis created with correct structurejs_scenarioformat matches actual implementationnpm run buildto verify integration with build process🤖 Generated with Claude Code