search

microsoft / typespec

https://typespec.io/
MIT License
4.49k stars 214 forks source link

[Epic] Feature Gap between OpenAPI 3.0 Emitter and OpenAPI 3.0 Specification #3836

Closed wanlwanl closed 1 week ago

wanlwanl commented 3 months ago

It's a issue to track feature gap between typespec OAS3 emitter and OAS3, it's not a ask.

### Bugs
- [ ] https://github.com/microsoft/typespec/issues/3885
- [ ] https://github.com/microsoft/typespec/issues/3887
- [ ] https://github.com/microsoft/typespec/issues/4097
- [ ] https://github.com/microsoft/typespec/issues/4584
- [ ] https://github.com/microsoft/typespec/issues/4707
- [ ] https://github.com/microsoft/typespec/issues/3889
- [ ] https://github.com/microsoft/typespec/issues/4869
### Not Supported Features
- [ ] https://github.com/microsoft/typespec/issues/3926
- [ ] https://github.com/microsoft/typespec/issues/3928
- [ ] https://github.com/microsoft/typespec/issues/3925
- [ ] https://github.com/microsoft/typespec/issues/3945
- [ ] Failed to limit by template type: https://github.com/joseharriaga/openai-in-typespec/pull/161/files#diff-c20be432499dab9965f03acd95280668d4ddf939c32878fd6a17a0048ecf6690
- [ ] https://github.com/microsoft/typespec/issues/4511
- [ ] https://github.com/microsoft/typespec/issues/4321
- [ ] https://github.com/microsoft/typespec/issues/3293
- [ ] https://github.com/microsoft/typespec/issues/2220
markcowl commented 3 months ago

@wanlwanl please fill in details of the ask

wanlwanl commented 3 months ago

Updated

skywing918 commented 3 months ago

OpenAPI 3 Emitter failed to add specification extension in root https://github.com/microsoft/typespec/issues/3870

OpenAPI 3 Emitter failed to define a webhooks in root -- oas v3.1.0 https://github.com/microsoft/typespec/issues/3882

OpenAPI 3 Emitter failed to define a jsonSchemaDialect in root -- oas v3.1.0 https://github.com/microsoft/typespec/issues/3883

bterlson commented 3 months ago

I think we should be clearly separating features in 3.1 which we do not support intentionally (and thus are feature requests not bugs) and things which impact 3.0 which we do target.

wanlwanl commented 3 months ago

Sure. Let's focus on 3.0 @skywing918

lirenhe commented 3 months ago

cc @allenjzhang for awareness.

skywing918 commented 3 months ago

• OpenAPI 3 Emitter failed to check type of termsOfService in @info https://github.com/microsoft/typespec/issues/3885

• @info decorator failed to exclude unallow keys, it only allow fixed fields and start with "x-". https://github.com/microsoft/typespec/issues/3887

• @server decorator failed to generate without description.

https://github.com/microsoft/typespec/issues/3924

• Path Item object not support fields Summary/description/parameters

https://github.com/microsoft/typespec/issues/3925

• operation object not support fields Callbacks/security

https://github.com/microsoft/typespec/issues/3926

• Parameter object not support fields allowEmptyValue/deprecated/example/examples/content https://github.com/microsoft/typespec/issues/3928

• Response object not support field links https://github.com/microsoft/typespec/issues/3927

• @tag decorator not support tag object https://github.com/microsoft/typespec/issues/3923

skywing918 commented 3 months ago

OpenAPI 3 Emitter failed to add specification extension in objects https://github.com/microsoft/typespec/issues/3941

wanlwanl commented 1 week ago

Use https://github.com/orgs/Azure/projects/142/views/1 to track OAS 3 emitter issues in the future