docs(kms): signing api endpoints

backend/src/lib/api-docs/constants.ts

@@ -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)."
   }
 };

backend/src/server/routes/v1/cmek-router.ts

@@ -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)
       }),

docs/api-reference/endpoints/kms/signing/public-key.mdx

@@ -0,0 +1,4 @@
+---
+title: "Retrieve Public Key"
+openapi: "GET /api/v1/kms/keys/{keyId}/public-key"
+---

docs/api-reference/endpoints/kms/signing/sign.mdx

@@ -0,0 +1,4 @@
+---
+title: "Sign Data"
+openapi: "POST /api/v1/kms/keys/{keyId}/sign"
+---

docs/api-reference/endpoints/kms/signing/signing-algorithms.mdx

@@ -0,0 +1,4 @@
+---
+title: "List Signing Algorithms"
+openapi: "GET /api/v1/kms/keys/{keyId}/signing-algorithms"
+---

docs/api-reference/endpoints/kms/signing/verify.mdx

@@ -0,0 +1,4 @@
+---
+title: "Verify Signature"
+openapi: "POST /api/v1/kms/keys/{keyId}/verify"
+---

docs/mint.json

@@ -1176,9 +1176,23 @@
             "api-reference/endpoints/kms/keys/get-by-name",
             "api-reference/endpoints/kms/keys/create",
             "api-reference/endpoints/kms/keys/update",
-            "api-reference/endpoints/kms/keys/delete",
-            "api-reference/endpoints/kms/keys/encrypt",
-            "api-reference/endpoints/kms/keys/decrypt"
+            "api-reference/endpoints/kms/keys/delete"
+          ]
+        },
+        {
+          "group": "Encryption",
+          "pages": [
+            "api-reference/endpoints/kms/encryption/encrypt",
+            "api-reference/endpoints/kms/encryption/decrypt"
+          ]
+        },
+        {
+          "group": "Signing",
+          "pages": [
+            "api-reference/endpoints/kms/signing/sign",
+            "api-reference/endpoints/kms/signing/verify",
+            "api-reference/endpoints/kms/signing/public-key",
+            "api-reference/endpoints/kms/signing/signing-algorithms"
           ]
         }
       ]