feat: creation of a new .getOperationById() method
#892
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
Aug 23, 2024
packages/oas/test/index.test.ts
Outdated
There was a problem hiding this comment.
best to look at this file with whitespace changes turned off 🙃
erunion
commented
Aug 23, 2024
| @@ -76,13 +76,13 @@ Because this library has full TypeScript types and docblocks this README is not | |||
| <!-- prettier-ignore-start --> | |||
| | Method | Description | | |||
| | :--- | :--- | | |||
| | `#dereference()` | Dereference the current OpenAPI definition. Note that this will ignore circular references. | | |||
There was a problem hiding this comment.
Changed these # to a . to better indicate that they're instance methods, not static.
erunion
commented
Aug 23, 2024
| | `.findOperation()` | Discover an operation with the current OpenAPI definition that matches a given URL and HTTP method. | | ||
| | `.findOperationWithoutMethod()` | Like `.findOperation()` but without supplying an HTTP method. | | ||
| | `.getOperation()` | Same as `.findOperation()` but this returns an instance of the `Operation` class. | | ||
| | `.getOperationById()` | Retrieve an operation in an OpenAPI definition by an `operationId`. | |
There was a problem hiding this comment.
docs for the new method ^
erunion
commented
Aug 23, 2024
| await circular.dereference(); | ||
|
|
||
| const reduced = reducer(circular.api as any, { paths: { '/anything': ['get'] } }); | ||
| expect(Object.keys(reduced.paths['/anything'])).toStrictEqual(['get', 'post']); |
kanadgupta
reviewed
Aug 23, 2024
| await circular.dereference(); | ||
|
|
||
| const reduced = reducer(circular.api as any, { paths: { '/anything': ['get'] } }); | ||
| expect(Object.keys(reduced.paths['/anything'])).toStrictEqual(['get', 'post']); |
Co-authored-by: Kanad Gupta <[email protected]>
kanadgupta
approved these changes
Aug 23, 2024
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.
🧰 Changes
This creates a new
.getOperationById()method on the mainOasinstance that allows us to retrieve anOperationorWebhookinstance by either theoperationIdthat's set to the schema, or if that's missing then the default generated behavior fromOperation.getOperationId().I plan on using this within our main app to retrieve
pathandmethodfor an operation based on the data I have for it: just anoperationId.🧬 QA & Testing
The tests I wrote have been sort of ported over from the
Operation.getOperationById()tests but heavily reduced as I don't need to re-test that thing.