feat: ensuring that exported definitions are sorted by path and method #225
Conversation
This file contains 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
erunion
commented
Nov 4, 2021
| function mergeEndpointsWithBase(swaggerBase = {}, endpoints = []) { | ||
| // To ensure consistent sorting of HTTP methods let's universally enforce the following order. | ||
| const methodPriority = new Map(); | ||
| ['get', 'post', 'put', 'patch', 'delete', 'options', 'head', 'trace'].forEach((x, i) => methodPriority.set(x, i)); |
There was a problem hiding this comment.
Since logically when reading an API definition having delete come before a get operation doesn't really make sense I'm forcing the sort to be this specific order.
gratcliff
approved these changes
Nov 4, 2021
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.
🧰 What's being changed?
A common problem we've had with large codebases is that we can't guarantee that exported definitions are always exported with the same ordering. This often results in us making in non-API changes to a codebase that happen to also force a resorting of operations within the exported API definition for who knows why.
To combat that I'm introducing a force of alphabetical sorting on paths, path operations, and component schemas.
🧬 Testing
There aren't any snapshot updates here because i changed the
__tests__/__fixtures__/project-openapi/api.jsfixture to have non-alpha sorted content -- ensuring that these changes work.