chore: audit api spec with vacuum #166
Conversation
starfy84
force-pushed
the
DX-2457-audit-api-specs
branch
from
ba98825 to
4585e72
Compare
mrdanish26
left a comment
mrdanish26
left a comment
There was a problem hiding this comment.
Can you fix the CI failure please
starfy84
force-pushed
the
DX-2457-audit-api-specs
branch
from
4585e72 to
3ada1a1
Compare
Should be good now, thanks! Also, feel free to merge the PR after approving, I don't have permissions to merge to master |
There was a problem hiding this comment.
Pull request overview
This PR introduces automated API specification auditing using the Vacuum tool to ensure OpenAPI specification quality. The changes add a comprehensive ruleset configuration and integrate the auditing process into the CI/CD pipeline to catch API specification issues early in the development cycle.
Key Changes:
- Added a custom ruleset.yaml configuration with 27 validation rules covering schemas, operations, security, and best practices
- Integrated Vacuum v0.18.1 into the pull request workflow to automatically audit generated API specifications
- New CI job generates OpenAPI specs and validates them against the ruleset, failing the build on errors
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| ruleset.yaml | Defines comprehensive validation rules for OpenAPI specifications including schema validation, security checks, and operation requirements with BitGo-specific customizations for tags and operationIds |
| .github/workflows/pull_request.yaml | Adds new audit-api-spec job that installs dependencies, downloads Vacuum CLI tool, generates API spec from source, and validates it with custom ruleset |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mrdanish26
left a comment
mrdanish26
left a comment
There was a problem hiding this comment.
Can you address the copilot's comments
starfy84
force-pushed
the
DX-2457-audit-api-specs
branch
from
103edee to
e88f439
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
starfy84
force-pushed
the
DX-2457-audit-api-specs
branch
from
d3c2184 to
84a464f
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
starfy84
force-pushed
the
DX-2457-audit-api-specs
branch
from
84a464f to
dbf12d1
Compare
Ticket: DX-2457