misc: finalized endpoint and doc

This commit is contained in:
Sheen Capadngan
2025-01-27 21:33:48 +08:00
parent c4446389b0
commit 49e6d7a861
20 changed files with 79 additions and 7 deletions
@@ -3,7 +3,7 @@ import { SecretSync } from "@app/services/secret-sync/secret-sync-enums";
import { TSecretSyncListItem } from "@app/services/secret-sync/secret-sync-types"; import { TSecretSyncListItem } from "@app/services/secret-sync/secret-sync-types";
export const GCP_SYNC_LIST_OPTION: TSecretSyncListItem = { export const GCP_SYNC_LIST_OPTION: TSecretSyncListItem = {
name: "GCP", name: "GCP Secret Manager",
destination: SecretSync.GCP, destination: SecretSync.GCP,
connection: AppConnection.GCP, connection: AppConnection.GCP,
canImportSecrets: false canImportSecrets: false
@@ -30,7 +30,7 @@ export const UpdateGcpSyncSchema = GenericUpdateSecretSyncFieldsSchema(SecretSyn
}); });
export const GcpSyncListItemSchema = z.object({ export const GcpSyncListItemSchema = z.object({
name: z.literal("GCP"), name: z.literal("GCP Secret Manager"),
connection: z.literal(AppConnection.GCP), connection: z.literal(AppConnection.GCP),
destination: z.literal(SecretSync.GCP), destination: z.literal(SecretSync.GCP),
canImportSecrets: z.literal(false) canImportSecrets: z.literal(false)
@@ -1,7 +1,7 @@
export enum SecretSync { export enum SecretSync {
AWSParameterStore = "aws-parameter-store", AWSParameterStore = "aws-parameter-store",
GitHub = "github", GitHub = "github",
GCP = "gcp" GCP = "gcp-secret-manager"
} }
export enum SecretSyncInitialSyncBehavior { export enum SecretSyncInitialSyncBehavior {
@@ -0,0 +1,4 @@
---
title: "Available"
openapi: "GET /api/v1/app-connections/gcp/available"
---
@@ -0,0 +1,10 @@
---
title: "Create"
openapi: "POST /api/v1/app-connections/gcp"
---
<Note>
Check out the configuration docs for [GCP
Connections](/integrations/app-connections/gcp) to learn how to obtain the
required credentials.
</Note>
@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/app-connections/gcp/{connectionId}"
---
@@ -0,0 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v1/app-connections/gcp/{connectionId}"
---
@@ -0,0 +1,4 @@
---
title: "Get by Name"
openapi: "GET /api/v1/app-connections/gcp/connection-name/{connectionName}"
---
@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/app-connections/gcp"
---
@@ -0,0 +1,10 @@
---
title: "Update"
openapi: "PATCH /api/v1/app-connections/gcp/{connectionId}"
---
<Note>
Check out the configuration docs for [GCP
Connections](/integrations/app-connections/gcp) to learn how to obtain the
required credentials.
</Note>
@@ -0,0 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/secret-syncs/gcp-secret-manager"
---
@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/secret-syncs/gcp-secret-manager/{syncId}"
---
@@ -0,0 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v1/secret-syncs/gcp-secret-manager/{syncId}"
---
@@ -0,0 +1,4 @@
---
title: "Get by Name"
openapi: "GET /api/v1/secret-syncs/gcp-secret-manager/sync-name/{syncName}"
---
@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/secret-syncs/gcp-secret-manager"
---
@@ -0,0 +1,4 @@
---
title: "Remove Secrets"
openapi: "POST /api/v1/secret-syncs/gcp-secret-manager/{syncId}/remove-secrets"
---
@@ -0,0 +1,4 @@
---
title: "Sync Secrets"
openapi: "POST /api/v1/secret-syncs/gcp-secret-manager/{syncId}/sync-secrets"
---
@@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/secret-syncs/gcp-secret-manager/{syncId}"
---
@@ -54,13 +54,13 @@ description: "Learn how to configure a GCP Secret Manager Sync for Infisical."
</Tab> </Tab>
<Tab title="API"> <Tab title="API">
To create a **GCP Secret Manager Sync**, make an API request to the [Create GCP To create a **GCP Secret Manager Sync**, make an API request to the [Create GCP
Secret Manager Sync](/api-reference/endpoints/secret-syncs/gcp/create) API endpoint. Secret Manager Sync](/api-reference/endpoints/secret-syncs/gcp-secret-manager/create) API endpoint.
### Sample request ### Sample request
```bash Request ```bash Request
curl --request POST \ curl --request POST \
--url https://app.infisical.com/api/v1/secret-syncs/gcp \ --url https://app.infisical.com/api/v1/secret-syncs/gcp-secret-manager \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data '{ --data '{
"destinationConfig": { "destinationConfig": {
@@ -123,7 +123,7 @@ description: "Learn how to configure a GCP Secret Manager Sync for Infisical."
"id": "1447389e-16fb-49ba-96fd-361b5a2522af", "id": "1447389e-16fb-49ba-96fd-361b5a2522af",
"path": "/" "path": "/"
}, },
"destination": "gcp", "destination": "gcp-secret-manager",
"destinationConfig": { "destinationConfig": {
"projectId": "infisical-test-playground" "projectId": "infisical-test-playground"
} }
+1 -1
View File
@@ -1,7 +1,7 @@
export enum SecretSync { export enum SecretSync {
AWSParameterStore = "aws-parameter-store", AWSParameterStore = "aws-parameter-store",
GitHub = "github", GitHub = "github",
GCP = "gcp" GCP = "gcp-secret-manager"
} }
export enum SecretSyncStatus { export enum SecretSyncStatus {