Merge pull request #2292 from Infisical/doc/add-dynamic-secrets-to-ap…

…i-reference doc: add dynamic secrets to api references
Infisical · Aug 15, 2024 · fa31f87 · fa31f87
2 parents 4570de0 + b176f13
commit fa31f87
Show file tree

Hide file tree

Showing 12 changed files with 56 additions and 1 deletion.
diff --git a/backend/src/ee/routes/v1/dynamic-secret-lease-router.ts b/backend/src/ee/routes/v1/dynamic-secret-lease-router.ts
@@ -131,7 +131,7 @@ export const registerDynamicSecretLeaseRouter = async (server: FastifyZodProvide
           .default("/")
           .transform(removeTrailingSlash)
           .describe(DYNAMIC_SECRET_LEASES.RENEW.path),
-        environmentSlug: z.string().min(1).describe(DYNAMIC_SECRET_LEASES.RENEW.ttl)
+        environmentSlug: z.string().min(1).describe(DYNAMIC_SECRET_LEASES.RENEW.environmentSlug)
       }),
       response: {
         200: z.object({

diff --git a/docs/api-reference/endpoints/dynamic-secrets/create-lease.mdx b/docs/api-reference/endpoints/dynamic-secrets/create-lease.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create Lease"
+openapi: "POST /api/v1/dynamic-secrets/leases"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/create.mdx b/docs/api-reference/endpoints/dynamic-secrets/create.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/dynamic-secrets"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/delete-lease.mdx b/docs/api-reference/endpoints/dynamic-secrets/delete-lease.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete Lease"
+openapi: "DELETE /api/v1/dynamic-secrets/leases/{leaseId}"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/delete.mdx b/docs/api-reference/endpoints/dynamic-secrets/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/dynamic-secrets/{name}"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/get-lease.mdx b/docs/api-reference/endpoints/dynamic-secrets/get-lease.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get Lease"
+openapi: "GET /api/v1/dynamic-secrets/leases/{leaseId}"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/get.mdx b/docs/api-reference/endpoints/dynamic-secrets/get.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get"
+openapi: "GET /api/v1/dynamic-secrets/{name}"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/list-leases.mdx b/docs/api-reference/endpoints/dynamic-secrets/list-leases.mdx
@@ -0,0 +1,4 @@
+---
+title: "List Leases"
+openapi: "GET /api/v1/dynamic-secrets/{name}/leases"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/list.mdx b/docs/api-reference/endpoints/dynamic-secrets/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/dynamic-secrets"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/renew-lease.mdx b/docs/api-reference/endpoints/dynamic-secrets/renew-lease.mdx
@@ -0,0 +1,4 @@
+---
+title: "Renew Lease"
+openapi: "POST /api/v1/dynamic-secrets/leases/{leaseId}/renew"
+---
diff --git a/docs/api-reference/endpoints/dynamic-secrets/update.mdx b/docs/api-reference/endpoints/dynamic-secrets/update.mdx
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/dynamic-secrets/{name}"
+---
diff --git a/docs/mint.json b/docs/mint.json
@@ -617,6 +617,21 @@
             "api-reference/endpoints/secrets/detach-tags"
           ]
         },
+        {
+          "group": "Dynamic Secrets",
+          "pages": [
+            "api-reference/endpoints/dynamic-secrets/create",
+            "api-reference/endpoints/dynamic-secrets/update",
+            "api-reference/endpoints/dynamic-secrets/delete",
+            "api-reference/endpoints/dynamic-secrets/get",
+            "api-reference/endpoints/dynamic-secrets/list",
+            "api-reference/endpoints/dynamic-secrets/list-leases",
+            "api-reference/endpoints/dynamic-secrets/create-lease",
+            "api-reference/endpoints/dynamic-secrets/delete-lease",
+            "api-reference/endpoints/dynamic-secrets/renew-lease",
+            "api-reference/endpoints/dynamic-secrets/get-lease"
+          ]
+        },
         {
           "group": "Secret Imports",
           "pages": [