Merge pull request #1704 from Infisical/daniel/remove-api-key-auth-docs

Feat: Remove API Key auth docs
This commit is contained in:
vmatsiiako
2024-04-18 14:19:38 -07:00
committed by GitHub
13 changed files with 25 additions and 81 deletions
+1 -3
View File
@@ -19,7 +19,6 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => {
description: "Return project secret snapshots ids", description: "Return project secret snapshots ids",
security: [ security: [
{ {
apiKeyAuth: [],
bearerAuth: [] bearerAuth: []
} }
], ],
@@ -97,8 +96,7 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => {
description: "Return audit logs", description: "Return audit logs",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -69,7 +69,6 @@ export const registerSnapshotRouter = async (server: FastifyZodProvider) => {
description: "Roll back project secrets to those captured in a secret snapshot version.", description: "Roll back project secrets to those captured in a secret snapshot version.",
security: [ security: [
{ {
apiKeyAuth: [],
bearerAuth: [] bearerAuth: []
} }
], ],
-6
View File
@@ -30,12 +30,6 @@ export const fastifySwagger = fp(async (fastify) => {
scheme: "bearer", scheme: "bearer",
bearerFormat: "JWT", bearerFormat: "JWT",
description: "An access token in Infisical" description: "An access token in Infisical"
},
apiKeyAuth: {
type: "apiKey",
in: "header",
name: "X-API-Key",
description: "An API Key in Infisical"
} }
} }
} }
@@ -18,8 +18,7 @@ export const registerProjectEnvRouter = async (server: FastifyZodProvider) => {
description: "Create environment", description: "Create environment",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -77,8 +76,7 @@ export const registerProjectEnvRouter = async (server: FastifyZodProvider) => {
description: "Update environment", description: "Update environment",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -144,8 +142,7 @@ export const registerProjectEnvRouter = async (server: FastifyZodProvider) => {
description: "Delete environment", description: "Delete environment",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -26,8 +26,7 @@ export const registerProjectMembershipRouter = async (server: FastifyZodProvider
description: "Return project user memberships", description: "Return project user memberships",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -139,8 +138,7 @@ export const registerProjectMembershipRouter = async (server: FastifyZodProvider
description: "Update project user membership", description: "Update project user membership",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -213,8 +211,7 @@ export const registerProjectMembershipRouter = async (server: FastifyZodProvider
description: "Delete project user membership", description: "Delete project user membership",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -19,8 +19,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) =>
description: "Create folders", description: "Create folders",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
body: z.object({ body: z.object({
@@ -76,8 +75,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) =>
description: "Update folder", description: "Update folder",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -140,8 +138,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) =>
description: "Delete a folder", description: "Delete a folder",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -200,8 +197,7 @@ export const registerSecretFolderRouter = async (server: FastifyZodProvider) =>
description: "Get folders", description: "Get folders",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
querystring: z.object({ querystring: z.object({
@@ -19,8 +19,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) =>
description: "Create secret imports", description: "Create secret imports",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
body: z.object({ body: z.object({
@@ -84,8 +83,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) =>
description: "Update secret imports", description: "Update secret imports",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -159,8 +157,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) =>
description: "Delete secret imports", description: "Delete secret imports",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -223,8 +220,7 @@ export const registerSecretImportRouter = async (server: FastifyZodProvider) =>
description: "Get secret imports", description: "Get secret imports",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
querystring: z.object({ querystring: z.object({
@@ -18,8 +18,7 @@ export const registerIdentityOrgRouter = async (server: FastifyZodProvider) => {
description: "Return organization identity memberships", description: "Return organization identity memberships",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -17,8 +17,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => {
description: "Return organization user memberships", description: "Return organization user memberships",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -66,8 +65,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => {
description: "Return projects in organization that user is part of", description: "Return projects in organization that user is part of",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -115,8 +113,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => {
description: "Update organization user memberships", description: "Update organization user memberships",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -158,8 +155,7 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => {
description: "Delete organization user memberships", description: "Delete organization user memberships",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -36,11 +36,6 @@ export const registerProjectRouter = async (server: FastifyZodProvider) => {
}, },
schema: { schema: {
description: "Return encrypted project key", description: "Return encrypted project key",
security: [
{
apiKeyAuth: []
}
],
params: z.object({ params: z.object({
workspaceId: z.string().trim().describe(PROJECTS.GET_KEY.workspaceId) workspaceId: z.string().trim().describe(PROJECTS.GET_KEY.workspaceId)
}), }),
@@ -85,11 +85,6 @@ export const registerUserRouter = async (server: FastifyZodProvider) => {
}, },
schema: { schema: {
description: "Return organizations that current user is part of", description: "Return organizations that current user is part of",
security: [
{
apiKeyAuth: []
}
],
response: { response: {
200: z.object({ 200: z.object({
organizations: OrganizationsSchema.array() organizations: OrganizationsSchema.array()
@@ -217,11 +212,6 @@ export const registerUserRouter = async (server: FastifyZodProvider) => {
}, },
schema: { schema: {
description: "Retrieve the current user on the request", description: "Retrieve the current user on the request",
security: [
{
apiKeyAuth: []
}
],
response: { response: {
200: z.object({ 200: z.object({
user: UsersSchema.merge(UserEncryptionKeysSchema.omit({ verifier: true })) user: UsersSchema.merge(UserEncryptionKeysSchema.omit({ verifier: true }))
+5 -10
View File
@@ -158,8 +158,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => {
description: "List secrets", description: "List secrets",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
querystring: z.object({ querystring: z.object({
@@ -280,8 +279,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => {
description: "Get a secret by name", description: "Get a secret by name",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -375,8 +373,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => {
description: "Create secret", description: "Create secret",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -464,8 +461,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => {
description: "Update secret", description: "Update secret",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
@@ -550,8 +546,7 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => {
description: "Delete secret", description: "Delete secret",
security: [ security: [
{ {
bearerAuth: [], bearerAuth: []
apiKeyAuth: []
} }
], ],
params: z.object({ params: z.object({
-8
View File
@@ -398,13 +398,6 @@
{ {
"group": "Endpoints", "group": "Endpoints",
"pages": [ "pages": [
{
"group": "Users",
"pages": [
"api-reference/endpoints/users/me",
"api-reference/endpoints/users/my-organizations"
]
},
{ {
"group": "Identities", "group": "Identities",
"pages": [ "pages": [
@@ -450,7 +443,6 @@
"api-reference/endpoints/workspaces/list-identity-memberships", "api-reference/endpoints/workspaces/list-identity-memberships",
"api-reference/endpoints/workspaces/update-identity-membership", "api-reference/endpoints/workspaces/update-identity-membership",
"api-reference/endpoints/workspaces/delete-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/secret-snapshots",
"api-reference/endpoints/workspaces/rollback-snapshot" "api-reference/endpoints/workspaces/rollback-snapshot"
] ]