feat: implement OpenAPI auto-discovery system - #12
Open
iacapuca wants to merge 1 commit into
Open
Conversation
Implement a self-discovery system for OpenAPI spec generation that eliminates
manual registration of API apps.
Changes:
- Add scripts/generate-all-openapi.ts for automatic app discovery
- Update root package.json to use discovery script
- Remove generate-openapi from individual app build scripts
- Add comprehensive documentation in docs/OPENAPI_DISCOVERY.md
- Update README.md with auto-discovery information
- Add tsx as dev dependency for running discovery script
Discovery Criteria:
Apps are automatically discovered if they have:
1. A 'generate-openapi' script in package.json
2. A src/generate-openapi.ts file
Benefits:
- Zero configuration - new apps are automatically discovered
- No manual registration in any central file
- Consistent behavior across all API services
- Single command (pnpm generate-openapi) generates all specs
- Specs are automatically copied to docs app
Example Output:
🔍 Discovering apps with OpenAPI generation capability...
Found 3 app(s) with OpenAPI generation:
✓ cyclist-counts (@atlas/cyclist-counts)
✓ cyclist-profile (@atlas/cyclist-profile)
✓ traffic-deaths (@atlas/traffic-deaths)
🎉 All OpenAPI specs generated successfully!
This is the first step in implementing self-discovery patterns across
the monorepo to reduce manual configuration and improve developer experience.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Implement a self-discovery system for OpenAPI spec generation that eliminates manual registration of API apps.
Changes:
Discovery Criteria:
Apps are automatically discovered if they have:
Benefits:
Example Output:
🔍 Discovering apps with OpenAPI generation capability...
Found 3 app(s) with OpenAPI generation: ✓ cyclist-counts (@atlas/cyclist-counts) ✓ cyclist-profile (@atlas/cyclist-profile) ✓ traffic-deaths (@atlas/traffic-deaths)
🎉 All OpenAPI specs generated successfully!
This is the first step in implementing self-discovery patterns across the monorepo to reduce manual configuration and improve developer experience.