How to define constant string variable in swagger open api 3.0 ? If I define enum it would be like as follows
"StatusCode": {
"title": "StatusCode",
"enum": [
"success",
"fail"
],
"type": "string"
}
But enums can be list of values, Is there any way to define string constant in swagger open api 3.0
code can be executed form the http://editor.swagger.io/
Firstly, we start by specifying the array of strings in Swagger using YAML notation. In the schema section, we include type: array with items String.
As @Helen already pointed out, and as you can read in the linked answer, currently it does not seem to get any better than an enum
with only one value. Full example that can be pasted into http://editor.swagger.io/:
{
"openapi": "3.0.0",
"info": {
"title": "Some API",
"version": "Some version"
},
"paths": {},
"components": {
"schemas": {
"StatusCode": {
"title": "StatusCode",
"enum": [
"The only possible value"
],
"type": "string"
}
}
}
}
There is a related topic on Github which is unsolved as of now: https://github.com/OAI/OpenAPI-Specification/issues/1313
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With