Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a generic mechanism to add extension to node that don't have a typespec type equivalent #3925

Open
Tracked by #3941 ...
skywing918 opened this issue Jul 22, 2024 · 2 comments
Labels
design:needed A design request has been raised that needs a proposal feature New feature or request lib:openapi triaged:core
Milestone

Comments

@skywing918
Copy link
Member

skywing918 commented Jul 22, 2024

There is many nodes in the openapi document where you can add extension but they don't have a typespec type you can use @extension to.
This include:

  • servers
  • paths
  • requestBody
  • responses object
  • response object
  • body
  • externalDocs
  • OAuth Flows Object
  • OAuth Flow Object
@skywing918 skywing918 added the bug Something isn't working label Jul 22, 2024
@timotheeguerin timotheeguerin changed the title [Bug]: Path Item object not support fields Summary/description/parameters Path Item object not support fields Summary/description/parameters Jul 22, 2024
@timotheeguerin timotheeguerin added feature New feature or request and removed bug Something isn't working labels Jul 22, 2024
@timotheeguerin
Copy link
Member

For parameters i don't think this is something we'll want to support as the goal was to provide some common params which is achieved directly in TypeSpec and duplicating those in each operation is equivalent.

For summary and description I also wonder what the usefulness of this is and feel like this is something that need user request to consider.

@markcowl
Copy link
Contributor

  • consider adding a general mechanism for providing values for fields in OpenAPI that are not directly supported by the emitter

@markcowl markcowl added design:needed A design request has been raised that needs a proposal lib:openapi labels Jul 22, 2024
@markcowl markcowl added this to the Backlog milestone Jul 22, 2024
@timotheeguerin timotheeguerin changed the title Path Item object not support fields Summary/description/parameters Add a generic mechanism to add extension to node that don't have a typespec type equivalent Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design:needed A design request has been raised that needs a proposal feature New feature or request lib:openapi triaged:core
Projects
None yet
Development

No branches or pull requests

3 participants