Merge pull request #2292 from Infisical/doc/add-dynamic-secrets-to-api-reference

doc: add dynamic secrets to api references
This commit is contained in:
Sheen Capadngan
2024-08-15 15:37:42 +08:00
committed by GitHub
12 changed files with 56 additions and 1 deletions
@@ -131,7 +131,7 @@ export const registerDynamicSecretLeaseRouter = async (server: FastifyZodProvide
.default("/") .default("/")
.transform(removeTrailingSlash) .transform(removeTrailingSlash)
.describe(DYNAMIC_SECRET_LEASES.RENEW.path), .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: { response: {
200: z.object({ 200: z.object({
@@ -0,0 +1,4 @@
---
title: "Create Lease"
openapi: "POST /api/v1/dynamic-secrets/leases"
---
@@ -0,0 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/dynamic-secrets"
---
@@ -0,0 +1,4 @@
---
title: "Delete Lease"
openapi: "DELETE /api/v1/dynamic-secrets/leases/{leaseId}"
---
@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/dynamic-secrets/{name}"
---
@@ -0,0 +1,4 @@
---
title: "Get Lease"
openapi: "GET /api/v1/dynamic-secrets/leases/{leaseId}"
---
@@ -0,0 +1,4 @@
---
title: "Get"
openapi: "GET /api/v1/dynamic-secrets/{name}"
---
@@ -0,0 +1,4 @@
---
title: "List Leases"
openapi: "GET /api/v1/dynamic-secrets/{name}/leases"
---
@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/dynamic-secrets"
---
@@ -0,0 +1,4 @@
---
title: "Renew Lease"
openapi: "POST /api/v1/dynamic-secrets/leases/{leaseId}/renew"
---
@@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/dynamic-secrets/{name}"
---
+15
View File
@@ -617,6 +617,21 @@
"api-reference/endpoints/secrets/detach-tags" "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", "group": "Secret Imports",
"pages": [ "pages": [