You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We recently upgraded from OpenAPI 3.0 to 3.1. Upon doing so we found that the additionalProperties: false false was being rendered to additionalProp1. This is a known bug that was fixed in version 5.2.0. We upgraded to the latest version (5.7.2) and found that the spacing in our endpoint parameters had become 'squished'. (see screenshot). I dug around using chrome inspect and found that the margin in the paragraph tag was set to 1em in version 5.2.0 and 0em in versions >= 5.3.0. I dug around some more and found that in version 5.3.0 a fix to descriptions alignment was merged, and may be the cause of our issue.
Margin set to 1 em in 5.2.0
Margin set to 0 em in 5.7.2
Example Swagger/OpenAPI definition:
{
"openapi": "3.1.0",
"info": {
"title": "DEMO 6.2.0",
"version": "",
"description": "DEMO Using swagger-ui-dist 5.2.0"
},
"paths": {
"/api/eligibility/npi/{npi}": {
"get": {
"description": "Look up public information for a single provider by NPI.",
"parameters": [
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {}
}
}
}
},
"components": {
"parameters": {
"accept": {
"name": "Accept",
"in": "header",
"description": "Request a content type and a specific API version. For example, to request `application/json`\nand version 4 of the API, the header value should be `application/vnd.qpp.cms.gov.v4+json`.\nThe API will return the default version if the Accept header is not\nincluded or if the requested version is not supported.\n",
"schema": {
"type": "string",
"enum": [
"application/vnd.qpp.cms.gov.v4+json"
],
"default": "application/vnd.qpp.cms.gov.v4+json"
},
"required": false
}
}
}
}
See spacing for acceptable values and default values
Expected behavior
I would have expected the parameter space to have not changed between versions. We would prefer the 1em margins in the parameters.
Screenshots
See above
Additional context or thoughts
Based on the comments in #8963 it seems like that ticket was a harmonization of margins across multiple files. So it is unclear if this is a true bug for a bug/feature that we have been used to.
The text was updated successfully, but these errors were encountered:
Q&A (please complete the following information)
Content & configuration
We recently upgraded from OpenAPI 3.0 to 3.1. Upon doing so we found that the
additionalProperties: false
false was being rendered toadditionalProp1
. This is a known bug that was fixed in version 5.2.0. We upgraded to the latest version (5.7.2) and found that the spacing in our endpoint parameters had become 'squished'. (see screenshot). I dug around using chrome inspect and found that the margin in the paragraph tag was set to1em
in version 5.2.0 and0em
in versions >= 5.3.0. I dug around some more and found that in version 5.3.0 a fix to descriptions alignment was merged, and may be the cause of our issue.Margin set to 1 em in 5.2.0
Margin set to 0 em in 5.7.2
Example Swagger/OpenAPI definition:
Swagger-UI configuration options:
Describe the bug you're encountering
To reproduce...
Steps to reproduce the behavior:
node app.js
GET api/eligibility/npi/{npi}
Expected behavior
I would have expected the parameter space to have not changed between versions. We would prefer the 1em margins in the parameters.
Screenshots
See above
Additional context or thoughts
Based on the comments in #8963 it seems like that ticket was a harmonization of margins across multiple files. So it is unclear if this is a true bug for a bug/feature that we have been used to.
The text was updated successfully, but these errors were encountered: