[openapi-to-tsp][Feature request] Generate response headers defined in swagger
- Dominant language
- TypeSpec
- Stars
- 4.8k
- Forks
- 736
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 1
Description
The converter currently seems to ignore response headers defined in swagger when converting to TypeSpec. Some specifications that widely use response headers, like App Configuration, would benefit from outputting response headers to reduce the amount of work necessary post conversion.
Example specification: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json
Example readme: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/appconfiguration/data-plane/readme.md
cc @joheredi
Contributor guide
Research direction
Start by reading the openapi-to-tsp converter and the linked App Configuration specification and readme, focusing on response headers defined in Swagger. Done means the converter represents those response headers in the generated TypeSpec output and the example specification no longer requires manual post-conversion work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100