Skip to content

Commit

Permalink
Fix typos in documentation of Bundle type (#384)
Browse files Browse the repository at this point in the history
  • Loading branch information
nmiyake authored Jan 15, 2025
1 parent 29adcb6 commit 134d573
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion gen/jsonschema/schemas/Bundle.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"dsseEnvelope": {
"$ref": "#/definitions/io.intoto.Envelope",
"additionalProperties": false,
"description": "A DSSE envelope can contain arbitrary payloads. Verifiers must verify that the payload type is a supported and expected type. This is part of the DSSE protocol which is defined here: \u003chttps://github.com/secure-systems-lab/dsse/blob/master/protocol.md\u003e DSSE envelopes in a bundle MUST have exactly one signture. This is a limitation from the DSSE spec, as it can contain multiple signatures. There are two primary reasons: 1. It simplfies the verification logic and policy 2. The bundle (currently) can only contain a single instance of the required verification materials During verification a client MUST reject an envelope if the number of signatures is not equal to one."
"description": "A DSSE envelope can contain arbitrary payloads. Verifiers must verify that the payload type is a supported and expected type. This is part of the DSSE protocol which is defined here: \u003chttps://github.com/secure-systems-lab/dsse/blob/master/protocol.md\u003e DSSE envelopes in a bundle MUST have exactly one signature. This is a limitation from the DSSE spec, as it can contain multiple signatures. There are two primary reasons: 1. It simplifies the verification logic and policy 2. The bundle (currently) can only contain a single instance of the required verification materials During verification a client MUST reject an envelope if the number of signatures is not equal to one."
}
},
"additionalProperties": false,
Expand Down
2 changes: 1 addition & 1 deletion gen/jsonschema/schemas/Input.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"dsseEnvelope": {
"$ref": "#/definitions/io.intoto.Envelope",
"additionalProperties": false,
"description": "A DSSE envelope can contain arbitrary payloads. Verifiers must verify that the payload type is a supported and expected type. This is part of the DSSE protocol which is defined here: \u003chttps://github.com/secure-systems-lab/dsse/blob/master/protocol.md\u003e DSSE envelopes in a bundle MUST have exactly one signture. This is a limitation from the DSSE spec, as it can contain multiple signatures. There are two primary reasons: 1. It simplfies the verification logic and policy 2. The bundle (currently) can only contain a single instance of the required verification materials During verification a client MUST reject an envelope if the number of signatures is not equal to one."
"description": "A DSSE envelope can contain arbitrary payloads. Verifiers must verify that the payload type is a supported and expected type. This is part of the DSSE protocol which is defined here: \u003chttps://github.com/secure-systems-lab/dsse/blob/master/protocol.md\u003e DSSE envelopes in a bundle MUST have exactly one signature. This is a limitation from the DSSE spec, as it can contain multiple signatures. There are two primary reasons: 1. It simplifies the verification logic and policy 2. The bundle (currently) can only contain a single instance of the required verification materials During verification a client MUST reject an envelope if the number of signatures is not equal to one."
}
},
"additionalProperties": false,
Expand Down
4 changes: 2 additions & 2 deletions gen/pb-go/bundle/v1/sigstore_bundle.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -186,10 +186,10 @@ pub mod bundle {
/// supported and expected type. This is part of the DSSE
/// protocol which is defined here:
/// <<https://github.com/secure-systems-lab/dsse/blob/master/protocol.md>>
/// DSSE envelopes in a bundle MUST have exactly one signture.
/// DSSE envelopes in a bundle MUST have exactly one signature.
/// This is a limitation from the DSSE spec, as it can contain
/// multiple signatures. There are two primary reasons:
/// 1. It simplfies the verification logic and policy
/// 1. It simplifies the verification logic and policy
/// 2. The bundle (currently) can only contain a single
/// instance of the required verification materials
/// During verification a client MUST reject an envelope if
Expand Down
Binary file not shown.
4 changes: 2 additions & 2 deletions protos/sigstore_bundle.proto
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,10 @@ message Bundle {
// supported and expected type. This is part of the DSSE
// protocol which is defined here:
// <https://github.com/secure-systems-lab/dsse/blob/master/protocol.md>
// DSSE envelopes in a bundle MUST have exactly one signture.
// DSSE envelopes in a bundle MUST have exactly one signature.
// This is a limitation from the DSSE spec, as it can contain
// multiple signatures. There are two primary reasons:
// 1. It simplfies the verification logic and policy
// 1. It simplifies the verification logic and policy
// 2. The bundle (currently) can only contain a single
// instance of the required verification materials
// During verification a client MUST reject an envelope if
Expand Down

0 comments on commit 134d573

Please sign in to comment.