Update API docs for GET /operator/keyring (#8691)

The response includes a new field: PrimaryKeys that lists the installed
primary keys.
This commit is contained in:
Hans Hasselberg 2020-09-15 21:35:02 +02:00 committed by GitHub
parent 6f1dd25139
commit 296340e13f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 2 deletions

View File

@ -66,7 +66,10 @@ $ curl \
"ZWTL+bgjHyQPhJRKcFe3ccirc2SFHmc/Nw67l8NQfdk=": 1, "ZWTL+bgjHyQPhJRKcFe3ccirc2SFHmc/Nw67l8NQfdk=": 1,
"WbL6oaTPom+7RG7Q/INbJWKy09OLar/Hf2SuOAdoQE4=": 1 "WbL6oaTPom+7RG7Q/INbJWKy09OLar/Hf2SuOAdoQE4=": 1
}, },
"NumNodes": 1 "PrimaryKeys": {
"pUqJrVyVRj5jsiYEkM/tFQYfWyJIv4s3XkvDwy7Cu5s=": 1,
},
"NumNodes": 3
}, },
{ {
"WAN": false, "WAN": false,
@ -77,7 +80,10 @@ $ curl \
"ZWTL+bgjHyQPhJRKcFe3ccirc2SFHmc/Nw67l8NQfdk=": 1, "ZWTL+bgjHyQPhJRKcFe3ccirc2SFHmc/Nw67l8NQfdk=": 1,
"WbL6oaTPom+7RG7Q/INbJWKy09OLar/Hf2SuOAdoQE4=": 1 "WbL6oaTPom+7RG7Q/INbJWKy09OLar/Hf2SuOAdoQE4=": 1
}, },
"NumNodes": 1 "PrimaryKeys": {
"pUqJrVyVRj5jsiYEkM/tFQYfWyJIv4s3XkvDwy7Cu5s=": 1,
},
"NumNodes": 3
} }
] ]
``` ```
@ -92,6 +98,9 @@ $ curl \
- `Keys` is a map of each gossip key to the number of nodes it's currently - `Keys` is a map of each gossip key to the number of nodes it's currently
installed on. installed on.
- `PrimaryKeys` is a map of each primary gossip key to the number of nodes it's currently
installed on.
- `NumNodes` is the total number of nodes in the datacenter. - `NumNodes` is the total number of nodes in the datacenter.
## Add New Gossip Encryption Key ## Add New Gossip Encryption Key