x-apidog-enum

用途

JSON Schema の enum 値に対し、名称や説明などの補足情報を付加するために使用する。

記述例

{
  "type": "string",
  "enum": [
    "1",
    "2"
  ],
  "x-apidog-enum": [
    {
      "value": "1", 
      "name": "One",
      "description": "最初の要素" 
    },
    { 
      "value": "2", 
      "name": "One",
      "description": "2 番目の要素"
    }
  ]
}

以下は旧バージョンの形式であり、非推奨である。

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

Modified at 2026-02-27 08:34:15

x-apidog-orders