Add API tag

backend/src/ee/routes/v1/pki-acme-router.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-floating-promises */
 import { z } from "zod";
 
+import { ApiDocsTags } from "@app/lib/api-docs";
 import { readLimit, writeLimit } from "@app/server/config/rateLimiter";
 
 export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
@@ -13,6 +14,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: readLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME Directory - provides URLs for the client to make API calls to",
       params: z.object({
         profileId: z.string().uuid()
@@ -47,6 +50,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: readLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME New Nonce - generate a new nonce and return in Replay-Nonce header",
       params: z.object({
         profileId: z.string().uuid()
@@ -73,6 +78,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: writeLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME New Account - register a new account or find existing one",
       params: z.object({
         profileId: z.string().uuid()
@@ -120,6 +127,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: writeLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME New Order - apply for a new certificate",
       params: z.object({
         profileId: z.string().uuid()
@@ -174,6 +183,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: writeLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME Account Deactivation",
       params: z.object({
         profileId: z.string().uuid(),
@@ -205,6 +216,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: readLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME List Orders - get existing orders from current account",
       params: z.object({
         profileId: z.string().uuid(),
@@ -233,6 +246,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: readLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME Get Order - return status and details of the order",
       params: z.object({
         profileId: z.string().uuid(),
@@ -275,6 +290,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: writeLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME Finalize Order - finalize cert order by providing CSR",
       params: z.object({
         profileId: z.string().uuid(),
@@ -321,6 +338,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: readLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME Download Certificate - download certificate when ready",
       params: z.object({
         profileId: z.string().uuid(),
@@ -348,6 +367,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: readLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME Identifier Authorization - get authorization info (challenges)",
       params: z.object({
         profileId: z.string().uuid(),
@@ -403,6 +424,8 @@ export const registerPkiAcmeRouter = async (server: FastifyZodProvider) => {
       rateLimit: writeLimit
     },
     schema: {
+      hide: false,
+      tags: [ApiDocsTags.PkiAcme],
       description: "ACME Respond to Challenge - let ACME server know challenge is ready",
       params: z.object({
         profileId: z.string().uuid(),

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

@@ -62,6 +62,7 @@ export enum ApiDocsTags {
   PkiCertificateCollections = "PKI Certificate Collections",
   PkiAlerting = "PKI Alerting",
   PkiSubscribers = "PKI Subscribers",
+  PkiAcme = "PKI ACME",
   SshCertificates = "SSH Certificates",
   SshCertificateAuthorities = "SSH Certificate Authorities",
   SshCertificateTemplates = "SSH Certificate Templates",