From 708c2af979dff2ae7521584ca3bc6bd730f59b75 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard <62331820+DanielHougaard@users.noreply.github.com> Date: Thu, 18 Apr 2024 20:48:38 +0200 Subject: [PATCH 1/5] Fix: Remove documentation for API-key only endpoints --- docs/mint.json | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/mint.json b/docs/mint.json index 114af99c3..97a237efb 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -405,13 +405,6 @@ { "group": "Endpoints", "pages": [ - { - "group": "Users", - "pages": [ - "api-reference/endpoints/users/me", - "api-reference/endpoints/users/my-organizations" - ] - }, { "group": "Identities", "pages": [ @@ -457,7 +450,6 @@ "api-reference/endpoints/workspaces/list-identity-memberships", "api-reference/endpoints/workspaces/update-identity-membership", "api-reference/endpoints/workspaces/delete-identity-membership", - "api-reference/endpoints/workspaces/workspace-key", "api-reference/endpoints/workspaces/secret-snapshots", "api-reference/endpoints/workspaces/rollback-snapshot" ] From 8f8553760af1227dfbd5243d53fbed24859c301b Mon Sep 17 00:00:00 2001 From: Daniel Hougaard <62331820+DanielHougaard@users.noreply.github.com> Date: Thu, 18 Apr 2024 20:49:12 +0200 Subject: [PATCH 2/5] Feat: Remove API key auth documentation --- backend/src/ee/routes/v1/project-router.ts | 4 +--- backend/src/ee/routes/v1/snapshot-router.ts | 1 - backend/src/server/routes/v1/project-env-router.ts | 9 +++------ .../server/routes/v1/project-membership-router.ts | 9 +++------ backend/src/server/routes/v1/secret-folder-router.ts | 12 ++++-------- backend/src/server/routes/v1/secret-import-router.ts | 12 ++++-------- backend/src/server/routes/v2/identity-org-router.ts | 3 +-- backend/src/server/routes/v2/organization-router.ts | 12 ++++-------- 8 files changed, 20 insertions(+), 42 deletions(-) diff --git a/backend/src/ee/routes/v1/project-router.ts b/backend/src/ee/routes/v1/project-router.ts index fd5a7048d..9795aaf86 100644 --- a/backend/src/ee/routes/v1/project-router.ts +++ b/backend/src/ee/routes/v1/project-router.ts @@ -19,7 +19,6 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => { description: "Return project secret snapshots ids", security: [ { - apiKeyAuth: [], bearerAuth: [] } ], @@ -97,8 +96,7 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => { description: "Return audit logs", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ diff --git a/backend/src/ee/routes/v1/snapshot-router.ts b/backend/src/ee/routes/v1/snapshot-router.ts index 7eee44f7e..6767f8383 100644 --- a/backend/src/ee/routes/v1/snapshot-router.ts +++ b/backend/src/ee/routes/v1/snapshot-router.ts @@ -69,7 +69,6 @@ export const registerSnapshotRouter = async (server: FastifyZodProvider) => { description: "Roll back project secrets to those captured in a secret snapshot version.", security: [ { - apiKeyAuth: [], bearerAuth: [] } ], diff --git a/backend/src/server/routes/v1/project-env-router.ts b/backend/src/server/routes/v1/project-env-router.ts index e1efa1637..ef51f865c 100644 --- a/backend/src/server/routes/v1/project-env-router.ts +++ b/backend/src/server/routes/v1/project-env-router.ts @@ -18,8 +18,7 @@ export const registerProjectEnvRouter = async (server: FastifyZodProvider) => { description: "Create environment", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -77,8 +76,7 @@ export const registerProjectEnvRouter = async (server: FastifyZodProvider) => { description: "Update environment", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -144,8 +142,7 @@ export const registerProjectEnvRouter = async (server: FastifyZodProvider) => { description: "Delete environment", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ diff --git a/backend/src/server/routes/v1/project-membership-router.ts b/backend/src/server/routes/v1/project-membership-router.ts index d99b4ec08..d2ed649db 100644 --- a/backend/src/server/routes/v1/project-membership-router.ts +++ b/backend/src/server/routes/v1/project-membership-router.ts @@ -26,8 +26,7 @@ export const registerProjectMembershipRouter = async (server: FastifyZodProvider description: "Return project user memberships", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -139,8 +138,7 @@ export const registerProjectMembershipRouter = async (server: FastifyZodProvider description: "Update project user membership", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -213,8 +211,7 @@ export const registerProjectMembershipRouter = async (server: FastifyZodProvider description: "Delete project user membership", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ diff --git a/backend/src/server/routes/v1/secret-folder-router.ts b/backend/src/server/routes/v1/secret-folder-router.ts index 36544de1c..3b8d0988f 100644 --- a/backend/src/server/routes/v1/secret-folder-router.ts +++ b/backend/src/server/routes/v1/secret-folder-router.ts @@ -19,8 +19,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) => description: "Create folders", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], body: z.object({ @@ -76,8 +75,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) => description: "Update folder", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -140,8 +138,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) => description: "Delete a folder", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -200,8 +197,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) => description: "Get folders", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], querystring: z.object({ diff --git a/backend/src/server/routes/v1/secret-import-router.ts b/backend/src/server/routes/v1/secret-import-router.ts index 0d3f547b3..d036fdbdd 100644 --- a/backend/src/server/routes/v1/secret-import-router.ts +++ b/backend/src/server/routes/v1/secret-import-router.ts @@ -19,8 +19,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) => description: "Create secret imports", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], body: z.object({ @@ -84,8 +83,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) => description: "Update secret imports", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -159,8 +157,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) => description: "Delete secret imports", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -223,8 +220,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) => description: "Get secret imports", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], querystring: z.object({ diff --git a/backend/src/server/routes/v2/identity-org-router.ts b/backend/src/server/routes/v2/identity-org-router.ts index b53e43ed0..aab84ef8d 100644 --- a/backend/src/server/routes/v2/identity-org-router.ts +++ b/backend/src/server/routes/v2/identity-org-router.ts @@ -18,8 +18,7 @@ export const registerIdentityOrgRouter = async (server: FastifyZodProvider) => { description: "Return organization identity memberships", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ diff --git a/backend/src/server/routes/v2/organization-router.ts b/backend/src/server/routes/v2/organization-router.ts index a4a66e992..4a4e8b15b 100644 --- a/backend/src/server/routes/v2/organization-router.ts +++ b/backend/src/server/routes/v2/organization-router.ts @@ -17,8 +17,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => { description: "Return organization user memberships", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -66,8 +65,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => { description: "Return projects in organization that user is part of", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -115,8 +113,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => { description: "Update organization user memberships", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -158,8 +155,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => { description: "Delete organization user memberships", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ From d71d59e399c9681b9fe8c0885a01c6be5b500aa3 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard <62331820+DanielHougaard@users.noreply.github.com> Date: Thu, 18 Apr 2024 20:50:52 +0200 Subject: [PATCH 3/5] Feat: Remove API key documentation --- backend/src/server/plugins/swagger.ts | 6 ------ 1 file changed, 6 deletions(-) diff --git a/backend/src/server/plugins/swagger.ts b/backend/src/server/plugins/swagger.ts index 2d7e6706c..99032bb6f 100644 --- a/backend/src/server/plugins/swagger.ts +++ b/backend/src/server/plugins/swagger.ts @@ -30,12 +30,6 @@ export const fastifySwagger = fp(async (fastify) => { scheme: "bearer", bearerFormat: "JWT", description: "An access token in Infisical" - }, - apiKeyAuth: { - type: "apiKey", - in: "header", - name: "X-API-Key", - description: "An API Key in Infisical" } } } From 5537b00a26161c7f273fe0613c8ac05c8645450d Mon Sep 17 00:00:00 2001 From: Daniel Hougaard <62331820+DanielHougaard@users.noreply.github.com> Date: Thu, 18 Apr 2024 20:51:18 +0200 Subject: [PATCH 4/5] Fix: Remove security field from schema due to api key-only auth --- backend/src/server/routes/v2/project-router.ts | 5 ----- backend/src/server/routes/v2/user-router.ts | 10 ---------- 2 files changed, 15 deletions(-) diff --git a/backend/src/server/routes/v2/project-router.ts b/backend/src/server/routes/v2/project-router.ts index 26c7cf30c..388cb7c2e 100644 --- a/backend/src/server/routes/v2/project-router.ts +++ b/backend/src/server/routes/v2/project-router.ts @@ -36,11 +36,6 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => { }, schema: { description: "Return encrypted project key", - security: [ - { - apiKeyAuth: [] - } - ], params: z.object({ workspaceId: z.string().trim().describe(PROJECTS.GET_KEY.workspaceId) }), diff --git a/backend/src/server/routes/v2/user-router.ts b/backend/src/server/routes/v2/user-router.ts index 217e32ddf..d1e80702f 100644 --- a/backend/src/server/routes/v2/user-router.ts +++ b/backend/src/server/routes/v2/user-router.ts @@ -85,11 +85,6 @@ export const registerUserRouter = async (server: FastifyZodProvider) => { }, schema: { description: "Return organizations that current user is part of", - security: [ - { - apiKeyAuth: [] - } - ], response: { 200: z.object({ organizations: OrganizationsSchema.array() @@ -217,11 +212,6 @@ export const registerUserRouter = async (server: FastifyZodProvider) => { }, schema: { description: "Retrieve the current user on the request", - security: [ - { - apiKeyAuth: [] - } - ], response: { 200: z.object({ user: UsersSchema.merge(UserEncryptionKeysSchema.omit({ verifier: true })) From 03848b30a2511ddc68cf3dd941f61942f2815f32 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard <62331820+DanielHougaard@users.noreply.github.com> Date: Thu, 18 Apr 2024 20:51:31 +0200 Subject: [PATCH 5/5] Feat: Remove API key auth documentation --- backend/src/server/routes/v3/secret-router.ts | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/backend/src/server/routes/v3/secret-router.ts b/backend/src/server/routes/v3/secret-router.ts index 8f4b2b728..b1d852a88 100644 --- a/backend/src/server/routes/v3/secret-router.ts +++ b/backend/src/server/routes/v3/secret-router.ts @@ -158,8 +158,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => { description: "List secrets", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], querystring: z.object({ @@ -280,8 +279,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => { description: "Get a secret by name", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -375,8 +373,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => { description: "Create secret", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -464,8 +461,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => { description: "Update secret", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({ @@ -550,8 +546,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => { description: "Delete secret", security: [ { - bearerAuth: [], - apiKeyAuth: [] + bearerAuth: [] } ], params: z.object({