feat(oas): adding support for common parameter detection to the analyzer #919
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
kanadgupta
approved these changes
Dec 16, 2024
| * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object} | ||
| */ | ||
| export function commonParameters(definition: OASDocument) { | ||
| return query(['$..paths[*].parameters'], definition).map(res => refizePointer(res.pointer)); |
There was a problem hiding this comment.
i believe the answer is "no" but just to double check — are there any other places in the tree where a parameter can be defined (other than at the path- and operation-level)?
There was a problem hiding this comment.
nope, this is the only place
| @@ -119,8 +119,8 @@ Because this library has full TypeScript types and docblocks this README is not | |||
| <!-- prettier-ignore-start --> | |||
| | Method | Description | | |||
| | :--- | :--- | | |||
| | `.getExtension()` | Retrieve a given [specification extension](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions) if it exists at the root of the API definition. | | |||
| | `.hasExtension()` | Determine if a given [specification extension](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions) exists on the root of the API definition. | | |||
| | `.getExtension()` | Retrieve a given [specification extension](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specification-extensions) if it exists at the root of the API definition. | | |||
There was a problem hiding this comment.
all of this work looks crazy tedious and i'd love to figure out how to auto-generate docs like these at some point, but in the meantime... bless u for this
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 adds support to
oas/analyzerfor surfacing information on if a given API definition utilizes common parameters.I've also gone through and updated a bunch of bad deep links to parts of the OAS. Would be nice if the OAI would stop breaking these deep links every couple of years.