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.

Sign up for GitHub

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

Jump to bottom

Migrate api spec file from Swagger 2.0 to OpenAPI 3.X #45418

Open
loynoir opened this issue Apr 27, 2023 · 1 comment · May be fixed by #46450
Open

Migrate api spec file from Swagger 2.0 to OpenAPI 3.X #45418

loynoir opened this issue Apr 27, 2023 · 1 comment · May be fixed by #46450
Labels
area/api area/docs kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. status/0-triage

Comments

@loynoir
Copy link

loynoir commented Apr 27, 2023 •
edited

Description

moby/docs/api/v1.42.yaml

Lines 2420 to 2426 in f117aef

Aliases:
type: "array"
items:
type: "string"
example:
- "server_x"
- "server_y"

But in runtime, .Aliases maybe null.

Although can workaround it, it would be nice to see docker migrate api spec file from Swagger 2.0 to OpenAPI 3.X, if possible.

Additional

drwpow/openapi-typescript#1083 (comment)

swagger 2.x does not have proper support for null arguments (over undefined).

drwpow/openapi-typescript#1083 (comment)

It's production ready. In 3.0.x there's a nullable property, and in 3.1.x I think that was replaced with the following:

oneOf:
- (your type)
- 'null'
@loynoir loynoir added kind/feature Functionality or other elements that the project doesn't currently have. Features are new and shiny status/0-triage labels Apr 27, 2023
@sam-thibault sam-thibault added area/api kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. area/docs and removed kind/feature Functionality or other elements that the project doesn't currently have. Features are new and shiny labels Apr 28, 2023
@sam-thibault
Copy link
Contributor

Somewhat related issue:

@thaJeztah thaJeztah linked a pull request Sep 18, 2023 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/api area/docs kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. status/0-triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[WIP] api: migrate swagger to OpenAPI v3 thaJeztah/docker
2 participants
@loynoir @sam-thibault