Documentation metadata for 3.3 branch (#10692)
* Update Documentation folder Signed-off-by: lucperkins <lucperkins@gmail.com> * Re-add README file Signed-off-by: lucperkins <lucperkins@gmail.com>
This commit is contained in:
Luc Perkins
@ -15,7 +15,7 @@
|
||||
"version": "version not set"
|
||||
},
|
||||
"paths": {
|
||||
"/v3beta/auth/authenticate": {
|
||||
"/v3/auth/authenticate": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -34,7 +34,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthenticateResponse"
|
||||
}
|
||||
@ -42,7 +42,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/disable": {
|
||||
"/v3/auth/disable": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -61,7 +61,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthDisableResponse"
|
||||
}
|
||||
@ -69,7 +69,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/enable": {
|
||||
"/v3/auth/enable": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -88,7 +88,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthEnableResponse"
|
||||
}
|
||||
@ -96,7 +96,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/role/add": {
|
||||
"/v3/auth/role/add": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -115,7 +115,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthRoleAddResponse"
|
||||
}
|
||||
@ -123,7 +123,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/role/delete": {
|
||||
"/v3/auth/role/delete": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -142,7 +142,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthRoleDeleteResponse"
|
||||
}
|
||||
@ -150,7 +150,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/role/get": {
|
||||
"/v3/auth/role/get": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -169,7 +169,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthRoleGetResponse"
|
||||
}
|
||||
@ -177,7 +177,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/role/grant": {
|
||||
"/v3/auth/role/grant": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -196,7 +196,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthRoleGrantPermissionResponse"
|
||||
}
|
||||
@ -204,7 +204,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/role/list": {
|
||||
"/v3/auth/role/list": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -223,7 +223,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthRoleListResponse"
|
||||
}
|
||||
@ -231,7 +231,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/role/revoke": {
|
||||
"/v3/auth/role/revoke": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -250,7 +250,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthRoleRevokePermissionResponse"
|
||||
}
|
||||
@ -258,7 +258,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/user/add": {
|
||||
"/v3/auth/user/add": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -277,7 +277,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthUserAddResponse"
|
||||
}
|
||||
@ -285,7 +285,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/user/changepw": {
|
||||
"/v3/auth/user/changepw": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -304,7 +304,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthUserChangePasswordResponse"
|
||||
}
|
||||
@ -312,7 +312,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/user/delete": {
|
||||
"/v3/auth/user/delete": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -331,7 +331,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthUserDeleteResponse"
|
||||
}
|
||||
@ -339,7 +339,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/user/get": {
|
||||
"/v3/auth/user/get": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -358,7 +358,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthUserGetResponse"
|
||||
}
|
||||
@ -366,7 +366,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/user/grant": {
|
||||
"/v3/auth/user/grant": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -385,7 +385,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthUserGrantRoleResponse"
|
||||
}
|
||||
@ -393,7 +393,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/user/list": {
|
||||
"/v3/auth/user/list": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -412,7 +412,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthUserListResponse"
|
||||
}
|
||||
@ -420,7 +420,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/auth/user/revoke": {
|
||||
"/v3/auth/user/revoke": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
@ -439,7 +439,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAuthUserRevokeRoleResponse"
|
||||
}
|
||||
@ -447,7 +447,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/cluster/member/add": {
|
||||
"/v3/cluster/member/add": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cluster"
|
||||
@ -466,7 +466,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbMemberAddResponse"
|
||||
}
|
||||
@ -474,7 +474,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/cluster/member/list": {
|
||||
"/v3/cluster/member/list": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cluster"
|
||||
@ -493,7 +493,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbMemberListResponse"
|
||||
}
|
||||
@ -501,7 +501,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/cluster/member/remove": {
|
||||
"/v3/cluster/member/remove": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cluster"
|
||||
@ -520,7 +520,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbMemberRemoveResponse"
|
||||
}
|
||||
@ -528,7 +528,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/cluster/member/update": {
|
||||
"/v3/cluster/member/update": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cluster"
|
||||
@ -547,7 +547,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbMemberUpdateResponse"
|
||||
}
|
||||
@ -555,7 +555,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/compaction": {
|
||||
"/v3/kv/compaction": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"KV"
|
||||
@ -574,7 +574,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbCompactionResponse"
|
||||
}
|
||||
@ -582,7 +582,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/deleterange": {
|
||||
"/v3/kv/deleterange": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"KV"
|
||||
@ -601,7 +601,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbDeleteRangeResponse"
|
||||
}
|
||||
@ -609,13 +609,13 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/lease/leases": {
|
||||
"/v3/kv/lease/leases": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
],
|
||||
"summary": "LeaseLeases lists all existing leases.",
|
||||
"operationId": "LeaseLeases",
|
||||
"operationId": "LeaseLeases2",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
@ -628,7 +628,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseLeasesResponse"
|
||||
}
|
||||
@ -636,13 +636,13 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/lease/revoke": {
|
||||
"/v3/kv/lease/revoke": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
],
|
||||
"summary": "LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.",
|
||||
"operationId": "LeaseRevoke",
|
||||
"operationId": "LeaseRevoke2",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
@ -655,7 +655,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseRevokeResponse"
|
||||
}
|
||||
@ -663,13 +663,13 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/lease/timetolive": {
|
||||
"/v3/kv/lease/timetolive": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
],
|
||||
"summary": "LeaseTimeToLive retrieves lease information.",
|
||||
"operationId": "LeaseTimeToLive",
|
||||
"operationId": "LeaseTimeToLive2",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
@ -682,7 +682,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseTimeToLiveResponse"
|
||||
}
|
||||
@ -690,7 +690,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/put": {
|
||||
"/v3/kv/put": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"KV"
|
||||
@ -709,7 +709,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbPutResponse"
|
||||
}
|
||||
@ -717,7 +717,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/range": {
|
||||
"/v3/kv/range": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"KV"
|
||||
@ -736,7 +736,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbRangeResponse"
|
||||
}
|
||||
@ -744,7 +744,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/kv/txn": {
|
||||
"/v3/kv/txn": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"KV"
|
||||
@ -763,7 +763,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbTxnResponse"
|
||||
}
|
||||
@ -771,7 +771,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/lease/grant": {
|
||||
"/v3/lease/grant": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
@ -790,7 +790,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseGrantResponse"
|
||||
}
|
||||
@ -798,7 +798,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/lease/keepalive": {
|
||||
"/v3/lease/keepalive": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
@ -807,7 +807,7 @@
|
||||
"operationId": "LeaseKeepAlive",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "(streaming inputs)",
|
||||
"description": " (streaming inputs)",
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@ -818,7 +818,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(streaming responses)",
|
||||
"description": "A successful response.(streaming responses)",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseKeepAliveResponse"
|
||||
}
|
||||
@ -826,7 +826,88 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/maintenance/alarm": {
|
||||
"/v3/lease/leases": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
],
|
||||
"summary": "LeaseLeases lists all existing leases.",
|
||||
"operationId": "LeaseLeases",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseLeasesRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseLeasesResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3/lease/revoke": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
],
|
||||
"summary": "LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.",
|
||||
"operationId": "LeaseRevoke",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseRevokeRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseRevokeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3/lease/timetolive": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Lease"
|
||||
],
|
||||
"summary": "LeaseTimeToLive retrieves lease information.",
|
||||
"operationId": "LeaseTimeToLive",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseTimeToLiveRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbLeaseTimeToLiveResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3/maintenance/alarm": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Maintenance"
|
||||
@ -845,7 +926,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbAlarmResponse"
|
||||
}
|
||||
@ -853,7 +934,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/maintenance/defragment": {
|
||||
"/v3/maintenance/defragment": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Maintenance"
|
||||
@ -872,7 +953,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbDefragmentResponse"
|
||||
}
|
||||
@ -880,12 +961,12 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/maintenance/hash": {
|
||||
"/v3/maintenance/hash": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Maintenance"
|
||||
],
|
||||
"summary": "HashKV computes the hash of all MVCC keys up to a given revision.",
|
||||
"summary": "HashKV computes the hash of all MVCC keys up to a given revision.\nIt only iterates \"key\" bucket in backend storage.",
|
||||
"operationId": "HashKV",
|
||||
"parameters": [
|
||||
{
|
||||
@ -899,7 +980,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbHashKVResponse"
|
||||
}
|
||||
@ -907,7 +988,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/maintenance/snapshot": {
|
||||
"/v3/maintenance/snapshot": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Maintenance"
|
||||
@ -926,7 +1007,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(streaming responses)",
|
||||
"description": "A successful response.(streaming responses)",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbSnapshotResponse"
|
||||
}
|
||||
@ -934,7 +1015,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/maintenance/status": {
|
||||
"/v3/maintenance/status": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Maintenance"
|
||||
@ -953,7 +1034,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbStatusResponse"
|
||||
}
|
||||
@ -961,7 +1042,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/maintenance/transfer-leadership": {
|
||||
"/v3/maintenance/transfer-leadership": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Maintenance"
|
||||
@ -980,7 +1061,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(empty)",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbMoveLeaderResponse"
|
||||
}
|
||||
@ -988,7 +1069,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v3beta/watch": {
|
||||
"/v3/watch": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Watch"
|
||||
@ -997,7 +1078,7 @@
|
||||
"operationId": "Watch",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "(streaming inputs)",
|
||||
"description": " (streaming inputs)",
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@ -1008,7 +1089,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(streaming responses)",
|
||||
"description": "A successful response.(streaming responses)",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/etcdserverpbWatchResponse"
|
||||
}
|
||||
@ -1286,10 +1367,12 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"format": "byte"
|
||||
},
|
||||
"range_end": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"format": "byte"
|
||||
},
|
||||
"role": {
|
||||
"type": "string"
|
||||
@ -2017,7 +2100,7 @@
|
||||
"format": "int64"
|
||||
},
|
||||
"min_create_revision": {
|
||||
"description": "min_create_revision is the lower bound for returned key create revisions; all keys with\nlesser create trevisions will be filtered away.",
|
||||
"description": "min_create_revision is the lower bound for returned key create revisions; all keys with\nlesser create revisions will be filtered away.",
|
||||
"type": "string",
|
||||
"format": "int64"
|
||||
},
|
||||
@ -2112,7 +2195,7 @@
|
||||
"format": "uint64"
|
||||
},
|
||||
"revision": {
|
||||
"description": "revision is the key-value store revision when the request was applied.",
|
||||
"description": "revision is the key-value store revision when the request was applied.\nFor watch progress responses, the header.revision indicates progress. All future events\nrecieved in this stream are guaranteed to have a higher revision number than the\nheader.revision number.",
|
||||
"type": "string",
|
||||
"format": "int64"
|
||||
}
|
||||
@ -2164,10 +2247,22 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"dbSize": {
|
||||
"description": "dbSize is the size of the backend database, in bytes, of the responding member.",
|
||||
"description": "dbSize is the size of the backend database physically allocated, in bytes, of the responding member.",
|
||||
"type": "string",
|
||||
"format": "int64"
|
||||
},
|
||||
"dbSizeInUse": {
|
||||
"description": "dbSizeInUse is the size of the backend database logically in use, in bytes, of the responding member.",
|
||||
"type": "string",
|
||||
"format": "int64"
|
||||
},
|
||||
"errors": {
|
||||
"description": "errors contains alarm/health information and status.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"header": {
|
||||
"$ref": "#/definitions/etcdserverpbResponseHeader"
|
||||
},
|
||||
@ -2176,8 +2271,13 @@
|
||||
"type": "string",
|
||||
"format": "uint64"
|
||||
},
|
||||
"raftAppliedIndex": {
|
||||
"description": "raftAppliedIndex is the current raft applied index of the responding member.",
|
||||
"type": "string",
|
||||
"format": "uint64"
|
||||
},
|
||||
"raftIndex": {
|
||||
"description": "raftIndex is the current raft index of the responding member.",
|
||||
"description": "raftIndex is the current raft committed index of the responding member.",
|
||||
"type": "string",
|
||||
"format": "uint64"
|
||||
},
|
||||
@ -2259,6 +2359,11 @@
|
||||
"$ref": "#/definitions/WatchCreateRequestFilterType"
|
||||
}
|
||||
},
|
||||
"fragment": {
|
||||
"description": "fragment enables splitting large revisions into multiple watch responses.",
|
||||
"type": "boolean",
|
||||
"format": "boolean"
|
||||
},
|
||||
"key": {
|
||||
"description": "key is the key to register for watching.",
|
||||
"type": "string",
|
||||
@ -2283,9 +2388,18 @@
|
||||
"description": "start_revision is an optional revision to watch from (inclusive). No start_revision is \"now\".",
|
||||
"type": "string",
|
||||
"format": "int64"
|
||||
},
|
||||
"watch_id": {
|
||||
"description": "If watch_id is provided and non-zero, it will be assigned to this watcher.\nSince creating a watcher in etcd is not a synchronous operation,\nthis can be used ensure that ordering is correct when creating multiple\nwatchers on the same stream. Creating a watcher with an ID already in\nuse on the stream will cause an error to be returned.",
|
||||
"type": "string",
|
||||
"format": "int64"
|
||||
}
|
||||
}
|
||||
},
|
||||
"etcdserverpbWatchProgressRequest": {
|
||||
"description": "Requests the a watch stream progress status be sent in the watch response stream as soon as\npossible.",
|
||||
"type": "object"
|
||||
},
|
||||
"etcdserverpbWatchRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -2294,6 +2408,9 @@
|
||||
},
|
||||
"create_request": {
|
||||
"$ref": "#/definitions/etcdserverpbWatchCreateRequest"
|
||||
},
|
||||
"progress_request": {
|
||||
"$ref": "#/definitions/etcdserverpbWatchProgressRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -2325,6 +2442,11 @@
|
||||
"$ref": "#/definitions/mvccpbEvent"
|
||||
}
|
||||
},
|
||||
"fragment": {
|
||||
"description": "framgment is true if large watch response was split over multiple responses.",
|
||||
"type": "boolean",
|
||||
"format": "boolean"
|
||||
},
|
||||
"header": {
|
||||
"$ref": "#/definitions/etcdserverpbResponseHeader"
|
||||
},
|
||||
|
||||
@ -15,13 +15,13 @@
|
||||
"application/json"
|
||||
],
|
||||
"paths": {
|
||||
"/v3beta/election/campaign": {
|
||||
"/v3/election/campaign": {
|
||||
"post": {
|
||||
"summary": "Campaign waits to acquire leadership in an election, returning a LeaderKey\nrepresenting the leadership if successful. The LeaderKey can then be used\nto issue new values on the election, transactionally guard API requests on\nleadership still being held, and resign from the election.",
|
||||
"operationId": "Campaign",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/v3electionpbCampaignResponse"
|
||||
}
|
||||
@ -42,13 +42,13 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v3beta/election/leader": {
|
||||
"/v3/election/leader": {
|
||||
"post": {
|
||||
"summary": "Leader returns the current election proclamation, if any.",
|
||||
"operationId": "Leader",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/v3electionpbLeaderResponse"
|
||||
}
|
||||
@ -69,13 +69,13 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v3beta/election/observe": {
|
||||
"/v3/election/observe": {
|
||||
"post": {
|
||||
"summary": "Observe streams election proclamations in-order as made by the election's\nelected leaders.",
|
||||
"operationId": "Observe",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "(streaming responses)",
|
||||
"description": "A successful response.(streaming responses)",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/v3electionpbLeaderResponse"
|
||||
}
|
||||
@ -96,13 +96,13 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v3beta/election/proclaim": {
|
||||
"/v3/election/proclaim": {
|
||||
"post": {
|
||||
"summary": "Proclaim updates the leader's posted value with a new value.",
|
||||
"operationId": "Proclaim",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/v3electionpbProclaimResponse"
|
||||
}
|
||||
@ -123,13 +123,13 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v3beta/election/resign": {
|
||||
"/v3/election/resign": {
|
||||
"post": {
|
||||
"summary": "Resign releases election leadership so other campaigners may acquire\nleadership on the election.",
|
||||
"operationId": "Resign",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/v3electionpbResignResponse"
|
||||
}
|
||||
@ -168,7 +168,7 @@
|
||||
"revision": {
|
||||
"type": "string",
|
||||
"format": "int64",
|
||||
"description": "revision is the key-value store revision when the request was applied."
|
||||
"description": "revision is the key-value store revision when the request was applied.\nFor watch progress responses, the header.revision indicates progress. All future events\nrecieved in this stream are guaranteed to have a higher revision number than the\nheader.revision number."
|
||||
},
|
||||
"raft_term": {
|
||||
"type": "string",
|
||||
|
||||
@ -15,13 +15,13 @@
|
||||
"application/json"
|
||||
],
|
||||
"paths": {
|
||||
"/v3beta/lock/lock": {
|
||||
"/v3/lock/lock": {
|
||||
"post": {
|
||||
"summary": "Lock acquires a distributed shared lock on a given named lock.\nOn success, it will return a unique key that exists so long as the\nlock is held by the caller. This key can be used in conjunction with\ntransactions to safely ensure updates to etcd only occur while holding\nlock ownership. The lock is held until Unlock is called on the key or the\nlease associate with the owner expires.",
|
||||
"operationId": "Lock",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/v3lockpbLockResponse"
|
||||
}
|
||||
@ -42,13 +42,13 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v3beta/lock/unlock": {
|
||||
"/v3/lock/unlock": {
|
||||
"post": {
|
||||
"summary": "Unlock takes a key returned by Lock and releases the hold on lock. The\nnext Lock caller waiting for the lock will then be woken up and given\nownership of the lock.",
|
||||
"operationId": "Unlock",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "",
|
||||
"description": "A successful response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/v3lockpbUnlockResponse"
|
||||
}
|
||||
@ -87,7 +87,7 @@
|
||||
"revision": {
|
||||
"type": "string",
|
||||
"format": "int64",
|
||||
"description": "revision is the key-value store revision when the request was applied."
|
||||
"description": "revision is the key-value store revision when the request was applied.\nFor watch progress responses, the header.revision indicates progress. All future events\nrecieved in this stream are guaranteed to have a higher revision number than the\nheader.revision number."
|
||||
},
|
||||
"raft_term": {
|
||||
"type": "string",
|
||||
@ -107,7 +107,7 @@
|
||||
"lease": {
|
||||
"type": "string",
|
||||
"format": "int64",
|
||||
"description": "lease is the ID of the lease that will be attached to ownership of the\nlock. If the lease expires or is revoked and currently holds the lock,\nthe lock is automatically released. Calls to Lock with the same lease will\nbe treated as a single acquistion; locking twice with the same lease is a\nno-op."
|
||||
"description": "lease is the ID of the lease that will be attached to ownership of the\nlock. If the lease expires or is revoked and currently holds the lock,\nthe lock is automatically released. Calls to Lock with the same lease will\nbe treated as a single acquisition; locking twice with the same lease is a\nno-op."
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user