github.com/hashicorp/vault/sdk@v0.13.0/framework/testdata/operations.json (about)

     1  {
     2    "openapi": "3.0.2",
     3    "info": {
     4      "title": "HashiCorp Vault API",
     5      "description": "HTTP API that gives you full access to Vault. All API routes are prefixed with `/v1/`.",
     6      "version": "<vault_version>",
     7      "license": {
     8        "name": "Mozilla Public License 2.0",
     9        "url": "https://www.mozilla.org/en-US/MPL/2.0"
    10      }
    11    },
    12    "paths": {
    13      "/foo/{id}": {
    14        "description": "Synopsis",
    15        "parameters": [
    16          {
    17            "name": "id",
    18            "description": "id path parameter",
    19            "in": "path",
    20            "schema": {
    21              "type": "string"
    22            },
    23            "required": true
    24          }
    25        ],
    26        "x-vault-sudo": true,
    27        "x-vault-createSupported": true,
    28        "x-vault-displayAttrs": {
    29          "navigation": true
    30        },
    31        "get": {
    32          "summary": "My Summary",
    33          "description": "My Description",
    34          "operationId": "kv-read-foo-id",
    35          "tags": [
    36            "secrets"
    37          ],
    38          "parameters": [
    39            {
    40              "name": "format",
    41              "description": "a query param",
    42              "in": "query",
    43              "schema": {
    44                "type": "string"
    45              }
    46            }
    47          ],
    48          "responses": {
    49            "200": {
    50              "description": "OK"
    51            }
    52          }
    53        },
    54        "post": {
    55          "summary": "Update Summary",
    56          "description": "Update Description",
    57          "operationId": "kv-write-foo-id",
    58          "tags": [
    59            "secrets"
    60          ],
    61          "requestBody": {
    62            "required": true,
    63            "content": {
    64              "application/json": {
    65                "schema": {
    66                  "$ref": "#/components/schemas/KvWriteFooIdRequest"
    67                }
    68              }
    69            }
    70          },
    71          "responses": {
    72            "200": {
    73              "description": "OK"
    74            }
    75          }
    76        }
    77      },
    78      "/foo/{id}/": {
    79        "description": "Synopsis",
    80        "parameters": [
    81          {
    82            "name": "id",
    83            "description": "id path parameter",
    84            "in": "path",
    85            "schema": {
    86              "type": "string"
    87            },
    88            "required": true
    89          }
    90        ],
    91        "x-vault-sudo": true,
    92        "x-vault-displayAttrs": {
    93          "navigation": true
    94        },
    95        "get": {
    96          "summary": "List Summary",
    97          "description": "List Description",
    98          "operationId": "kv-list-foo-id",
    99          "tags": [
   100            "secrets"
   101          ],
   102          "parameters": [
   103            {
   104              "name": "format",
   105              "description": "a query param",
   106              "in": "query",
   107              "schema": {
   108                "type": "string"
   109              }
   110            },
   111            {
   112              "name": "list",
   113              "description": "Must be set to `true`",
   114              "in": "query",
   115              "schema": {
   116                "type": "string",
   117                "enum": [
   118                  "true"
   119                ]
   120              },
   121              "required": true
   122            }
   123          ],
   124          "responses": {
   125            "200": {
   126              "description": "OK",
   127              "content": {
   128                "application/json": {
   129                  "schema": {
   130                    "$ref": "#/components/schemas/StandardListResponse"
   131                  }
   132                }
   133              }
   134            }
   135          }
   136        }
   137      }
   138    },
   139    "components": {
   140      "schemas": {
   141        "KvWriteFooIdRequest": {
   142          "type": "object",
   143          "properties": {
   144            "age": {
   145              "type": "integer",
   146              "description": "the age",
   147              "enum": [
   148                1,
   149                2,
   150                3
   151              ],
   152              "x-vault-displayAttrs": {
   153                "name": "Age",
   154                "value": 7,
   155                "sensitive": true,
   156                "group": "Some Group"
   157              }
   158            },
   159            "flavors": {
   160              "type": "array",
   161              "description": "the flavors",
   162              "items": {
   163                "type": "string"
   164              }
   165            },
   166            "format": {
   167              "type": "string",
   168              "description": "a query param"
   169            },
   170            "maximum": {
   171              "type": "integer",
   172              "description": "a maximum value",
   173              "format": "int64"
   174            },
   175            "name": {
   176              "type": "string",
   177              "description": "the name",
   178              "pattern": "\\w([\\w-.]*\\w)?",
   179              "default": "Larry"
   180            },
   181            "x-abc-token": {
   182              "type": "string",
   183              "description": "a header value",
   184              "enum": [
   185                "a",
   186                "b",
   187                "c"
   188              ]
   189            }
   190          },
   191          "required": [
   192            "age"
   193          ]
   194        },
   195        "StandardListResponse": {
   196          "type": "object",
   197          "properties": {
   198            "keys": {
   199              "type": "array",
   200              "items": {
   201                "type": "string"
   202              }
   203            }
   204          }
   205        }
   206      }
   207    }
   208  }