docs(kms): signing api endpoints

This commit is contained in:
Daniel Hougaard
2025-04-03 08:17:35 +04:00
parent c6ca668db9
commit c4c065ea9e
9 changed files with 38 additions and 8 deletions
+1 -1
View File
@@ -1641,7 +1641,7 @@ export const KMS = {
},
VERIFY: {
keyId: "The ID of the key to verify the data with.",
data: "The data in string format to be verified (base64 encoded).",
data: "The data in string format to be verified (base64 encoded). For data larger than 4096 bytes you must first create a digest of the data and then pass the digest in the data parameter.",
signature: "The signature to be verified (base64 encoded)."
}
};
+4 -4
View File
@@ -414,7 +414,7 @@ export const registerCmekRouter = async (server: FastifyZodProvider) => {
rateLimit: readLimit
},
schema: {
description: "Get public key for a KMS key",
description: "Get the public key for a KMS key that is used for signing and verifying data.",
params: z.object({
keyId: z.string().uuid().describe(KMS.GET_PUBLIC_KEY.keyId)
}),
@@ -444,7 +444,7 @@ export const registerCmekRouter = async (server: FastifyZodProvider) => {
rateLimit: readLimit
},
schema: {
description: "List signing algorithms for a KMS key",
description: "List all available signing algorithms for a KMS key",
params: z.object({
keyId: z.string().uuid().describe(KMS.LIST_SIGNING_ALGORITHMS.keyId)
}),
@@ -472,7 +472,7 @@ export const registerCmekRouter = async (server: FastifyZodProvider) => {
rateLimit: writeLimit
},
schema: {
description: "Sign data with KMS key",
description: "Sign data with a KMS key.",
params: z.object({
keyId: z.string().uuid().describe(KMS.SIGN.keyId)
}),
@@ -519,7 +519,7 @@ export const registerCmekRouter = async (server: FastifyZodProvider) => {
rateLimit: writeLimit
},
schema: {
description: "Verify data with KMS key",
description: "Verify data signatures with a KMS key.",
params: z.object({
keyId: z.string().uuid().describe(KMS.VERIFY.keyId)
}),