Skip to content

Commit 2a7011c

Browse files
committed
sled-agent: add doc comments to RoT endpoints
1 parent 46bc1f2 commit 2a7011c

3 files changed

Lines changed: 7 additions & 1 deletion

File tree

openapi/sled-agent/sled-agent-19.0.0-222a99.json renamed to openapi/sled-agent/sled-agent-19.0.0-c56f15.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,7 @@
512512
},
513513
"/rot/{rot}/attest": {
514514
"post": {
515+
"summary": "Return attestation over recorded measurments and nonce from the RoT.",
515516
"operationId": "rot_attest",
516517
"parameters": [
517518
{
@@ -556,6 +557,7 @@
556557
},
557558
"/rot/{rot}/certificate-chain": {
558559
"get": {
560+
"summary": "Return the certificate chain for the attestation signer from the RoT.",
559561
"operationId": "rot_certificate_chain",
560562
"parameters": [
561563
{
@@ -590,6 +592,7 @@
590592
},
591593
"/rot/{rot}/measurement-log": {
592594
"get": {
595+
"summary": "Return the set of measurments recorded by the RoT.",
593596
"operationId": "rot_measurement_log",
594597
"parameters": [
595598
{
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
sled-agent-19.0.0-222a99.json
1+
sled-agent-19.0.0-c56f15.json

sled-agent/api/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1376,6 +1376,7 @@ pub trait SledAgentApi {
13761376
path_params: Path<latest::attached_subnet::VmmSubnetPathParam>,
13771377
) -> Result<HttpResponseDeleted, HttpError>;
13781378

1379+
/// Return the set of measurments recorded by the RoT.
13791380
#[endpoint {
13801381
method = GET,
13811382
path = "/rot/{rot}/measurement-log",
@@ -1386,6 +1387,7 @@ pub trait SledAgentApi {
13861387
path_params: Path<latest::rot::RotPathParams>,
13871388
) -> Result<HttpResponseOk<latest::rot::MeasurementLog>, HttpError>;
13881389

1390+
/// Return the certificate chain for the attestation signer from the RoT.
13891391
#[endpoint {
13901392
method = GET,
13911393
path = "/rot/{rot}/certificate-chain",
@@ -1396,6 +1398,7 @@ pub trait SledAgentApi {
13961398
path_params: Path<latest::rot::RotPathParams>,
13971399
) -> Result<HttpResponseOk<latest::rot::CertificateChain>, HttpError>;
13981400

1401+
/// Return attestation over recorded measurments and nonce from the RoT.
13991402
#[endpoint {
14001403
method = POST,
14011404
path = "/rot/{rot}/attest",

0 commit comments

Comments
 (0)