How to define constant string in Swagger open api 3.0

Question

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/

You just need an `enum` with a single value. – Helen Aug 13 '18 at 10:53 — Helen, Aug 13 '18 at 10:53

score 27 · Accepted Answer · edited May 21 '20 at 15:38

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

then how const string array? – Jiang YD Nov 19 '19 at 07:15 — Jiang YD, Nov 19 '19 at 07:15

score 0 · Answer 2 · answered Aug 10 '18 at 06:13

You can define a constant parameter as a required parameter with only one possible value

But if you have more than one parameter it can't be an constant. In the api all value can be changed if have an multiple choice.

Ref: https://swagger.io/docs/specification/2-0/describing-parameters/

How to define constant string in Swagger open api 3.0

2 Answers2

Linked