tsp-openapi3: support path-level parameters #4708
Merged
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
chrisradek
requested review from
bterlson,
markcowl,
allenjzhang and
timotheeguerin
as code owners
chrisradek
changed the title
|
All changed packages have been documented.
Show changes
|
|
You can try these changes here
|
timotheeguerin
approved these changes
Oct 14, 2024
swatkatz
pushed a commit
to swatkatz/typespec
that referenced
this pull request
Nov 5, 2024
Fixes microsoft#4455 Previously, the parameters defined as a child of a `path` were ignored. Now they are added to the operations defined in each of the path's methods. The spec states that duplicates are not allowed in the final operation-level parameter list, and the more specific (operation level) replaces the less specific (path level) if there is a collision. A combination of the location and name uniquely identify a parameter for these purposes. Example: ```yml openapi: 3.0.0 info: title: (title) version: 0.0.0 tags: [] paths: /widgets/{id}: get: operationId: Widgets_read responses: "200": description: The request has succeeded. content: application/json: schema: $ref: "#/components/schemas/Widget" delete: operationId: Widgets_delete responses: "204": description: "There is no content to send for this request, but the headers may be useful. " parameters: - name: id in: path required: true schema: type: string components: schemas: Widget: type: object required: - id properties: id: type: string ``` --------- Co-authored-by: Christopher Radek <Christopher.Radek@microsoft.com>
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.
Fixes #4455
Previously, the parameters defined as a child of a
pathwere ignored. Now they are added to the operations defined in each of the path's methods.The spec states that duplicates are not allowed in the final operation-level parameter list, and the more specific (operation level) replaces the less specific (path level) if there is a collision. A combination of the location and name uniquely identify a parameter for these purposes.
Example: