Comments (4)
Thanks for reporting this.
How are you serializing the OpenAPI result to JSON? using the maven plugin? Probably the issue comes from not using Yaml31
class for (de)serialization
If the issue persist, please provide the full config to be able to reproduce the issue
from swagger-core.
Thanks for your reply.
I'm serializing the OpenAPI result to JSON using the maven plugin with the below config
<plugin>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-maven-plugin-jakarta</artifactId>
<executions>
<execution>
<id>test</id>
<phase>compile</phase>
<goals>
<goal>resolve</goal>
</goals>
<configuration>
<contextId>test</contextId>
<outputFileName>swagger</outputFileName>
<outputPath>${project.build.directory}/classes</outputPath>
<outputFormat>JSON</outputFormat>
<configurationFilePath>${basedir}/src/main/resources/swagger/configurationFile.json</configurationFilePath>
</configuration>
</execution>
</executions>
</plugin>
and config file
{
"resourcePackages": [
"com.test.rest"
],
"prettyPrint" : true,
"sortOutput" : true,
"openAPI31" : true,
"openAPI": {
"info": {
"version": "1.0",
"title": "Test API",
"description": "Test API."
},
"servers": [
{
"url": "$BASE-PATH$"
}
]
}
}
from swagger-core.
This is indeed a bug occurring when setting sortOutput
to true
. It has been fixed in #4677, and will be available in next release.
Said that, the result is actually still correct in terms of compliance with OpenAPI 3.1, and semantically equal to having type
value as string instead of array of strings with single value.
This is also supported by Swagger UI (for OAS 3.1), not sure why you're: which causes an issue when trying to call the endpoints from the swagger UI.
With current version removing the sortOutput
property will result in a single value in type
from swagger-core.
@frantuma Thank you for fixing the issue. I meant that having the type
as an array of strings caused an error when executing the endpints from the Swagger UI.
I have tested again after setting the sortOutput
to false
and it looks good in the UI but the APIs are not sorted as expected which should be fixed in the next release.
from swagger-core.
Related Issues (20)
- Distinguish between no default value specified and a default value `null` specified in the OpenAPI.
- Cyclic dependency with common base type swallows attributes
- `@Header.schema()` in `@ApiResponse` does not generate the `type` HOT 1
- io.swagger.v3.core.util.Json public static method mapper() is not thread safe
- Webhooks not rendered in generated spec HOT 2
- Incorrect OpenAPI specification produced for an Iterable of enums in Scala
- BUG @Schema#implementation not processed on properties when generating open api 3.1.0
- BUG properties of type Object do not have any type information when generating open api 3.1.0
- BUG @Schema#allowableValues adds enums but does not remove existing enum references when resolving enum as references and using open api 3.1.0
- BUG Unable to deserialize OpenAPI Parameter
- [BUG] Using builder setter and setting JsonProperty Access will not get property types correctly
- Representing "204 No Content" with jax-rs
- Open api 3.1.0 model resolvers are not used when generating models for constructor parameters of jax-rs resources
- Like to propose a new property to set Future ,UpComing ,InNextRelease something to represent API specification to showcase user what they can expect in next release
- Using @JsonUnwrapped with @Schema(implementation = Something) does not unwrap
- @Schema applied to two getters of type JsonNode returns one definition only
- C# SwaggerConfig added to VB.Net project
- BUG @Size is ignored in properties using collections when using oas 3.1.0
- BUG @Pattern on type parameter of properties using collections is ignored when using oas 3.1.0
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swagger-core.