doc: API references

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

@@ -1147,6 +1147,32 @@ export const CERTIFICATES = {
   }
 };
 
+export const CERTIFICATE_TEMPLATES = {
+  CREATE: {
+    caId: "The ID of the certificate authority to associate the template with",
+    pkiCollectionId: "The ID of the PKI collection to bind to the template",
+    name: "The name of the template",
+    commonName: "The regular expression string to use for validating common names",
+    subjectAlternativeName: "The regular expression string to use for validating subject alternative names",
+    ttl: "The max TTL for the template"
+  },
+  GET: {
+    certificateTemplateId: "The ID of the certificate template to get"
+  },
+  UPDATE: {
+    certificateTemplateId: "The ID of the certificate template to update",
+    caId: "The ID of the certificate authority to update the association with the template",
+    pkiCollectionId: "The ID of the PKI collection to update the binding to the template",
+    name: "The updated name of the template",
+    commonName: "The updated regular expression string for validating common names",
+    subjectAlternativeName: "The updated regular expression string for validating subject alternative names",
+    ttl: "The updated max TTL for the template"
+  },
+  DELETE: {
+    certificateTemplateId: "The ID of the certificate template to delete"
+  }
+};
+
 export const ALERTS = {
   CREATE: {
     projectId: "The ID of the project to create the alert in",

backend/src/server/routes/v1/certificate-template-router.ts

@@ -3,6 +3,7 @@ import { z } from "zod";
 
 import { CertificateTemplatesSchema } from "@app/db/schemas";
 import { EventType } from "@app/ee/services/audit-log/audit-log-types";
+import { CERTIFICATE_TEMPLATES } from "@app/lib/api-docs";
 import { readLimit, writeLimit } from "@app/server/config/rateLimiter";
 import { verifyAuth } from "@app/server/plugins/auth/verify-auth";
 import { AuthMode } from "@app/services/auth/auth-type";
@@ -27,7 +28,7 @@ export const registerCertificateTemplateRouter = async (server: FastifyZodProvid
     },
     schema: {
       params: z.object({
-        certificateTemplateId: z.string()
+        certificateTemplateId: z.string().describe(CERTIFICATE_TEMPLATES.GET.certificateTemplateId)
       }),
       response: {
         200: z.object({
@@ -73,12 +74,17 @@ export const registerCertificateTemplateRouter = async (server: FastifyZodProvid
     },
     schema: {
       body: z.object({
-        caId: z.string(),
+        caId: z.string().describe(CERTIFICATE_TEMPLATES.CREATE.caId),
-        pkiCollectionId: z.string().optional(),
+        pkiCollectionId: z.string().optional().describe(CERTIFICATE_TEMPLATES.CREATE.pkiCollectionId),
-        name: z.string().min(1),
+        name: z.string().min(1).describe(CERTIFICATE_TEMPLATES.CREATE.name),
-        commonName: validateTemplateRegexField,
+        commonName: validateTemplateRegexField.describe(CERTIFICATE_TEMPLATES.CREATE.commonName),
-        subjectAlternativeName: validateTemplateRegexField,
+        subjectAlternativeName: validateTemplateRegexField.describe(
-        ttl: z.string().refine((val) => ms(val) > 0, "TTL must be a positive number")
+          CERTIFICATE_TEMPLATES.CREATE.subjectAlternativeName
+        ),
+        ttl: z
+          .string()
+          .refine((val) => ms(val) > 0, "TTL must be a positive number")
+          .describe(CERTIFICATE_TEMPLATES.CREATE.ttl)
       }),
       response: {
         200: z.object({
@@ -119,18 +125,21 @@ export const registerCertificateTemplateRouter = async (server: FastifyZodProvid
     },
     schema: {
       body: z.object({
-        caId: z.string().optional(),
+        caId: z.string().optional().describe(CERTIFICATE_TEMPLATES.UPDATE.caId),
-        pkiCollectionId: z.string().optional(),
+        pkiCollectionId: z.string().optional().describe(CERTIFICATE_TEMPLATES.UPDATE.pkiCollectionId),
-        name: z.string().min(1).optional(),
+        name: z.string().min(1).optional().describe(CERTIFICATE_TEMPLATES.UPDATE.name),
-        commonName: validateTemplateRegexField.optional(),
+        commonName: validateTemplateRegexField.optional().describe(CERTIFICATE_TEMPLATES.UPDATE.commonName),
-        subjectAlternativeName: validateTemplateRegexField.optional(),
+        subjectAlternativeName: validateTemplateRegexField
+          .optional()
+          .describe(CERTIFICATE_TEMPLATES.UPDATE.subjectAlternativeName),
         ttl: z
           .string()
           .refine((val) => ms(val) > 0, "TTL must be a positive number")
           .optional()
+          .describe(CERTIFICATE_TEMPLATES.UPDATE.ttl)
       }),
       params: z.object({
-        certificateTemplateId: z.string()
+        certificateTemplateId: z.string().describe(CERTIFICATE_TEMPLATES.UPDATE.certificateTemplateId)
       }),
       response: {
         200: z.object({
@@ -172,7 +181,7 @@ export const registerCertificateTemplateRouter = async (server: FastifyZodProvid
     },
     schema: {
       params: z.object({
-        certificateTemplateId: z.string()
+        certificateTemplateId: z.string().describe(CERTIFICATE_TEMPLATES.DELETE.certificateTemplateId)
       }),
       response: {
         200: z.object({

docs/api-reference/endpoints/certificate-templates/create.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/pki/certificate-templates"
+---

docs/api-reference/endpoints/certificate-templates/delete.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/pki/certificate-templates/{certificateTemplateId}"
+---

docs/api-reference/endpoints/certificate-templates/get-by-id.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/pki/certificate-templates/{certificateTemplateId}"
+---

docs/api-reference/endpoints/certificate-templates/update.mdx

@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/pki/certificate-templates/{certificateTemplateId}"
+---

docs/api-reference/endpoints/certificates/issue-certificate.mdx

@@ -0,0 +1,4 @@
+---
+title: "Issue Certificate"
+openapi: "POST /api/v1/pki/certificates/issue-certificate"
+---

docs/api-reference/endpoints/certificates/sign-certificate.mdx

@@ -0,0 +1,4 @@
+---
+title: "Sign Certificate"
+openapi: "POST /api/v1/pki/certificates/sign-certificate"
+---

docs/mint.json

@@ -686,7 +686,18 @@
             "api-reference/endpoints/certificates/read",
             "api-reference/endpoints/certificates/revoke",
             "api-reference/endpoints/certificates/delete",
-            "api-reference/endpoints/certificates/cert-body"
+            "api-reference/endpoints/certificates/cert-body",
+            "api-reference/endpoints/certificates/issue-certificate",
+            "api-reference/endpoints/certificates/sign-certificate"
+          ]
+        },
+        {
+          "group": "Certificate Templates",
+          "pages": [
+            "api-reference/endpoints/certificate-templates/create",
+            "api-reference/endpoints/certificate-templates/update",
+            "api-reference/endpoints/certificate-templates/get-by-id",
+            "api-reference/endpoints/certificate-templates/delete"
           ]
         },
         {