Swagger: is it possible to make an operation parameter constant / readonly?

Question

This is the description of a certain parameter I have:

{
    "name": "myParam",
    "description": "My param description",
    "required": true,
    "paramType": "query",
    "type": "string",
    "defaultValue":"myValue"
}

The defaultValue is the only value the parameter can have, so is there a way to declare this? Seen in the context of the swagger-ui, I need the parameter's textbox to be read-only. I'm using swagger 1.2.

Thanks

Answer 1

The proper way to declare this would be:

{
    "name": "myParam",
    "description": "My param description",
    "required": true,
    "paramType": "query",
    "type": "string",
    "enum": [ "myValue" ]
}

The "enum" property sets the possible values. Once you set a single value to it, that's the only one that could be used and that would be available in the UI for the user to choose from.

Answer 2

I'm a bit late to the game but with OpenAPI 3.1 you can do the following:

defaultValue:
  type: string
  const:
   - myValue