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

OpenAPI 3.1.0 support: align normalization with OpenAPI 2 / 3.0.x #3627

Closed
char0n opened this issue Aug 9, 2024 · 1 comment · May be fixed by jetboard/swagger-editor#5
Closed

OpenAPI 3.1.0 support: align normalization with OpenAPI 2 / 3.0.x #3627

char0n opened this issue Aug 9, 2024 · 1 comment · May be fixed by jetboard/swagger-editor#5
Assignees
@char0n
Labels
cat: resolver type: bug version: 3.x

Comments

@char0n
Copy link
Member

char0n commented Aug 9, 2024

In #2743, the normalization for OpenAPI 3.1.0 was implemented. It performs all the normalization as described in OpenAPI specification.

Server normalization was implemented as well. How it works is described in https://github.com/swagger-api/apidom/blob/93e2d0f7f08add82309843abe991a3013440e5e2/packages/apidom-ns-openapi-3-1/src/refractor/plugins/normalize-servers.ts#L15.

But this server normalization is causing UX issues in SwaggerUI. If we do the normalization, server needs to be picked on Path Item and Operation level whenever we want to use Try it out feature, instead of just picking the server globally once.

The goal of this issue to turn on server normalization.
@char0n char0n self-assigned this Aug 9, 2024
char0n added a commit that referenced this issue Aug 9, 2024
@char0n
fix(resolver): disable Server Objects normalization for OpenAPI 3.1.0
ab4ee24 
Refs #3627
@char0n char0n mentioned this issue Aug 9, 2024
Merged
@char0n
Copy link
Member Author

char0n commented Aug 9, 2024

Addressed in #3628

@char0n char0n closed this as completed Aug 9, 2024
char0n added a commit that referenced this issue Aug 9, 2024
@char0n
fix(resolver): disable Server Objects normalization for OpenAPI 3.1.0 (…
d63f33f 
…#3628)

Refs #3627
swagger-bot pushed a commit that referenced this issue Aug 9, 2024
@semantic-release-bot
chore(release): cut the 3.28.3 release [skip ci]
7db9d0b 
## [3.28.3](v3.28.2...v3.28.3) (2024-08-09)

### Bug Fixes

* **resolver:** disable Server Objects normalization for OpenAPI 3.1.0 ([#3628](#3628)) ([d63f33f](d63f33f)), closes [#3627](#3627)
* **resolver:** don't skip normalization of OpenAPI 3.1.0 specs ([#3575](#3575)) ([bc4a40c](bc4a40c)), closes [#1396](#1396)
@jetboard jetboard mentioned this issue Oct 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@char0n char0n

Labels
cat: resolver type: bug version: 3.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Snyk] Upgrade swagger-client from 3.28.2 to 3.29.3 jetboard/swagger-editor
1 participant
@char0n