x-apidog-enum

Uso

Usado para adicionar informações descritivas adicionais aos valores de enum em um JSON Schema, incluindo os nomes e as descrições dos valores de enum.

Exemplo

{
  "type": "string",
  "enum": [
    "1",
    "2"
  ],
  "x-apidog-enum": [
    {
      "value": "1", 
      "name": "One",
      "description": "First element" 
    },
    { 
      "value": "2", 
      "name": "One",
      "description": "Second element"
    }
  ]
}

A seguir estão dados de versão históricos e foram descontinuados:

{
  "type": "string",
  "enum": [
    "1",
    "2"
  ],
  "x-apidog": {
    "enumDescriptions": {
        "1": "",
        "2": ""
    }
  }
}

Uso#

Exemplo#

Uso

Exemplo