mirror of
https://github.com/hashicorp/vault.git
synced 2026-06-27 10:00:32 -04:00
* deprecate snapshot query params, use a header instead * keep read query param, but deprecate recover one * fix test * remove list change * add changelog * rename header, allow request method * update changelog Co-authored-by: miagilepner <mia.epner@hashicorp.com>
95 lines
No EOL
2.4 KiB
JSON
95 lines
No EOL
2.4 KiB
JSON
{
|
|
"openapi": "3.0.2",
|
|
"info": {
|
|
"title": "HashiCorp Vault API",
|
|
"description": "HTTP API that gives you full access to Vault. All API routes are prefixed with `/v1/`.",
|
|
"version": "dummyversion",
|
|
"license": {
|
|
"name": "Mozilla Public License 2.0",
|
|
"url": "https://www.mozilla.org/en-US/MPL/2.0"
|
|
}
|
|
},
|
|
"paths": {
|
|
"/foo": {
|
|
"x-vault-displayAttrs": {
|
|
"navigation": true
|
|
},
|
|
"get": {
|
|
"operationId": "kv-read-foo",
|
|
"tags": [
|
|
"secrets"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "read_snapshot_id",
|
|
"description": "Targets the read operation to the provided loaded snapshot Id",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"operationId": "kv-write-foo",
|
|
"tags": [
|
|
"secrets"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "recover_snapshot_id",
|
|
"deprecated": true,
|
|
"description": "Triggers a recover operation using the given snapshot ID. Request body is ignored when a recover operation is requested.",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "X-Vault-Recover-Snapshot-Id",
|
|
"description": "Triggers a recover operation using the given snapshot ID. Request body is ignored when a recover operation is requested.",
|
|
"in": "header",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KvWriteFooRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"KvWriteFooRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the name",
|
|
"pattern": "\\w([\\w-.]*\\w)?",
|
|
"default": "Larry"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |