x-apidog-enum

使用方法

JSON Schema の enum 値に追加の説明情報を加えるために使用します。これには、enum 値の名前や説明が含まれます。

例

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

以下は過去バージョンのデータであり、非推奨となっています。

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

Modified at 2026-06-11 07:06:02

x-apidog-orders

サポートセンター