[Bug]: tsp-openapi3: common parameters not imported #4455
Assignees
Labels
bug
Something isn't working
openapi3:converter
Issues for @typespec/openapi3 openapi to typespec converter
triaged:core
Milestone
Comments
markcowl
added
the
openapi3:converter
github-merge-queue bot
pushed a commit
that referenced
this issue
Oct 14, 2024
Fixes #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 <[email protected]>
swatkatz
pushed a commit
to swatkatz/typespec
that referenced
this issue
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 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
Operation parameters defined as "common parameters" for a given path, instead of being copied to each individual path, are not imported at all.
detected as part of the "TypeSpec for Sefaria" hack.
Reproduction
See this gist that describes the same API with and without using common parameters: https://gist.github.com/Arithmomaniac/150cf23eb89141c92d3663cd49d080b1
Import result without using common parameters: Playground
Import result when using common parameters: Playground (won't even compile)
Checklist
The text was updated successfully, but these errors were encountered: