GCP.ApiGateway reference

ApisConfig

Source: src/GCP/ApiGateway/ApisConfig.ts

An API Gateway API config — OpenAPI or gRPC settings for a managed API that Gateways serve.

Parent API, config id, documents, gRPC definitions, and gateway service account are immutable. Display name and labels update in place. Configs live in locations/global.

ApisConfig: Creating an API Config

OpenAPI config

const config = yield* GCP.ApiGateway.ApisConfig("V1", {
  api: api.name,
  displayName: "v1",
  openapiDocuments: [
    {
      document: {
        path: "openapi.yaml",
        contents: openApi,
      },
    },
  ],
  labels: { env: "test" },
});

Named config

const config = yield* GCP.ApiGateway.ApisConfig("V1", {
  api: api.name,
  apiConfigId: "v1",
  openapiDocuments: [
    {
      document: {
        path: "openapi.yaml",
        contents: openApi,
      },
    },
  ],
});