Add API Key auth method to environment endpoints, add endpoints to public REST API docs

This commit is contained in:
Tuan Dang
2023-08-26 08:47:36 +01:00
parent 9416fca832
commit 84a866eb88
8 changed files with 36 additions and 11 deletions
+5 -5
View File
@@ -16,7 +16,7 @@ import {
router.post( router.post(
"/:workspaceId/environments", "/:workspaceId/environments",
requireAuth({ requireAuth({
acceptedAuthModes: [AuthMode.JWT], acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
}), }),
requireWorkspaceAuth({ requireWorkspaceAuth({
acceptedRoles: [ADMIN, MEMBER], acceptedRoles: [ADMIN, MEMBER],
@@ -32,7 +32,7 @@ router.post(
router.put( router.put(
"/:workspaceId/environments", "/:workspaceId/environments",
requireAuth({ requireAuth({
acceptedAuthModes: [AuthMode.JWT], acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
}), }),
requireWorkspaceAuth({ requireWorkspaceAuth({
acceptedRoles: [ADMIN, MEMBER], acceptedRoles: [ADMIN, MEMBER],
@@ -49,7 +49,7 @@ router.put(
router.patch( router.patch(
"/:workspaceId/environments", "/:workspaceId/environments",
requireAuth({ requireAuth({
acceptedAuthModes: [AuthMode.JWT], acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
}), }),
requireWorkspaceAuth({ requireWorkspaceAuth({
acceptedRoles: [ADMIN, MEMBER], acceptedRoles: [ADMIN, MEMBER],
@@ -67,7 +67,7 @@ router.patch(
router.delete( router.delete(
"/:workspaceId/environments", "/:workspaceId/environments",
requireAuth({ requireAuth({
acceptedAuthModes: [AuthMode.JWT], acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
}), }),
requireWorkspaceAuth({ requireWorkspaceAuth({
acceptedRoles: [ADMIN], acceptedRoles: [ADMIN],
@@ -82,7 +82,7 @@ router.delete(
router.get( router.get(
"/:workspaceId/environments", "/:workspaceId/environments",
requireAuth({ requireAuth({
acceptedAuthModes: [AuthMode.JWT], acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
}), }),
requireWorkspaceAuth({ requireWorkspaceAuth({
acceptedRoles: [MEMBER, ADMIN], acceptedRoles: [MEMBER, ADMIN],
@@ -0,0 +1,4 @@
---
title: "Create"
openapi: "POST /api/v2/workspace/{workspaceId}/environments"
---
@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v2/workspace/{workspaceId}/environments"
---
@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v2/workspace/{workspaceId}/environments"
---
@@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PUT /api/v2/workspace/{workspaceId}/environments"
---
@@ -1,6 +1,6 @@
--- ---
title: "Retrieve" title: "List"
openapi: "GET /api/v3/secrets/{secretName}" openapi: "GET /api/v3/secrets/"
--- ---
<Tip> <Tip>
@@ -1,6 +1,6 @@
--- ---
title: "Retrieve All" title: "Retrieve"
openapi: "GET /api/v3/secrets/" openapi: "GET /api/v3/secrets/{secretName}"
--- ---
<Tip> <Tip>
+11 -2
View File
@@ -321,12 +321,21 @@
"api-reference/endpoints/workspaces/rollback-snapshot" "api-reference/endpoints/workspaces/rollback-snapshot"
] ]
}, },
{
"group": "Environments",
"pages": [
"api-reference/endpoints/environments/list",
"api-reference/endpoints/environments/create",
"api-reference/endpoints/environments/update",
"api-reference/endpoints/environments/delete"
]
},
{ {
"group": "Secrets", "group": "Secrets",
"pages": [ "pages": [
"api-reference/endpoints/secrets/read", "api-reference/endpoints/secrets/list",
"api-reference/endpoints/secrets/create", "api-reference/endpoints/secrets/create",
"api-reference/endpoints/secrets/read-one", "api-reference/endpoints/secrets/read",
"api-reference/endpoints/secrets/update", "api-reference/endpoints/secrets/update",
"api-reference/endpoints/secrets/delete", "api-reference/endpoints/secrets/delete",
"api-reference/endpoints/secrets/versions", "api-reference/endpoints/secrets/versions",