Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(go): Add Go documentation trait #1307

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,9 @@ structure StormTrackingCache {
timeUnits: TimeUnits
}

@documentation("The time unit for gracePeriod, graceInterval, and inFlightTTL.
The default is seconds.
If this is set to milliseconds, then these values will be treated as milliseconds.")
@enum([
{
name: "Seconds",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ namespace aws.cryptography.materialProviders
//# | FORBID_ENCRYPT_ALLOW_DECRYPT |
//# | REQUIRE_ENCRYPT_ALLOW_DECRYPT |
//# | REQUIRE_ENCRYPT_REQUIRE_DECRYPT |
@documentation("Supported ESDK Commitment Policies. For more information, see: https://github.com/awslabs/aws-encryption-sdk-specification/blob/master/framework/commitment-policy.md#supported-format-commitment-policy-enum.")
@enum([
{
name: "FORBID_ENCRYPT_ALLOW_DECRYPT",
Expand All @@ -30,6 +31,7 @@ namespace aws.cryptography.materialProviders
])
string ESDKCommitmentPolicy

@documentation("Supported DBE Commitment Policies.")
@enum([
{
name: "REQUIRE_ENCRYPT_REQUIRE_DECRYPT",
Expand All @@ -54,7 +56,7 @@ union CommitmentPolicy {

// Padding

// Values come from: https://github.com/awslabs/aws-encryption-sdk-specification/blob/master/framework/raw-rsa-keyring.md#supported-padding-schemes
@documentation("Supported Padding Schemes. For more information, see: https://github.com/awslabs/aws-encryption-sdk-specification/blob/master/framework/raw-rsa-keyring.md#supported-padding-schemes.")
@enum([
{
name: "PKCS1",
Expand All @@ -79,7 +81,7 @@ union CommitmentPolicy {
])
string PaddingScheme

// AES wrapping algorithms
@documentation("Supported AES wrapping algorithms.")
@enum([
{
name: "ALG_AES128_GCM_IV12_TAG16",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ namespace aws.cryptography.materialProviders
// customer facing, we will need to either model the AlgorithmSuiteProperties
// as a separate structure (with an associated resource/operation for translating
// from name to properties) or use more advanced custom traits which allow us to
// model all properties of the algorithm suite in one structure.
// model all properties of the algorithm suite in one structure.
@documentation("Supported ESDK Algorithm Suite Ids.")
@enum([
{
name: "ALG_AES_128_GCM_IV12_TAG16_NO_KDF",
Expand Down Expand Up @@ -56,6 +57,7 @@ namespace aws.cryptography.materialProviders
])
string ESDKAlgorithmSuiteId

@documentation("Supported DBE Algorithm Suite Ids.")
@enum([
{
name: "ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_SYMSIG_HMAC_SHA384",
Expand Down

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.

Loading
Loading