feat: add slice command to filter OpenAPI specs #1056
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
…ation IDs, and paths - Add new 'extract' CLI command to slice OpenAPI specifications - Support filtering by operation IDs, tags, and path patterns - Implement SliceFilter with comprehensive test coverage - Use Cobra's StringSliceVar for cleaner flag handling - Include all referenced schemas and components in output - Add validation for input parameters and output formats - Support both YAML and JSON output formats
- Update command name from 'extract' to 'slice' for consistency - Update all examples and documentation to use 'slice' - All tests still pass
- Fix perfsprint linter error - Use errors.New instead of fmt.Errorf when no formatting is needed - Add errors import
- Replace fmt.Errorf with errors.New for non-formatted errors (perfsprint) - Fix receiver naming consistency in SliceFilter.matches method (revive) - Change receiver name from 'e' to 'f' to match other methods
andmatei
changed the title
- Add ParametersFilter to remove unused parameters from OpenAPI specs - Add comprehensive tests for ParametersFilter (7 test scenarios) - Move slice functionality from filter package to dedicated slice package - Update FiltersToCleanupRefs to include TagsFilter, ParametersFilter, and SchemasFilter - Fix linting issues (import shadowing and missing period in comment) - Slice command now cleans up unused tags, parameters, and schemas automatically
andmatei
changed the title
andmatei
requested review from
andreaangiolillo,
drinkbird,
lovisaberggren,
matt-condon,
wtrocki and
yelizhenden-mdb
| Version: "1.0", | ||
| }, | ||
| Paths: openapi3.NewPaths(openapi3.WithPath("/test/{id}", &openapi3.PathItem{ | ||
| Parameters: openapi3.Parameters{ |
Collaborator
There was a problem hiding this comment.
Could you help me to understand the equivalent of this Parameters field under PathItem in the OpenAPI spec?
Collaborator
There was a problem hiding this comment.
Or, would it make more sense under Get operation?
| Parameters: nil, | ||
| }, | ||
| }, | ||
| } |
Collaborator
There was a problem hiding this comment.
As far as I can see, these tests are all cases covering parameters referencing to other schemas? Can we have other tests for response and request bodies referencing to the schemas?
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.
Proposed changes
This PR adds a new
slicecommand to thefoasclithat enables users to slice/filter OpenAPI specifications by operation IDs, tags, or path patterns. This feature allows developers to create smaller, focused OpenAPI specs containing only the endpoints they needExample usage:
Jira ticket: CLOUDP-365849
Checklist
Changes to Spectral
Further comments