postman-cs/Postman Onboarding: GCP Spec Discovery

Discover GCP-hosted API specs and expose a spec path for Postman onboarding. Part of the Postman API Onboarding suite.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
mode	Discovery mode: resolve-one selects the single best service for this repository; discover-many exports every exportable candidate.	no	resolve-one
project-id	Google Cloud project ID used as the exact discovery and credential preflight scope.	yes	—
location	Google Cloud API Gateway location. v1 supports global.	no	global
api-id	Optional full API Gateway config, Cloud Endpoints config, Apigee proxy revision, Apigee archive deployment, API Hub spec, legacy Apigee Registry spec, Apigee portal apidoc, Vertex extension, Dialogflow tool, or CES tool/toolset resource name. Use this to bypass broader project discovery.	no	""
repo-slug	Repository slug (owner/name) used for repository-association matching against postman-repo resource labels. Defaults to the CI-detected repository (GITHUB_REPOSITORY).	no	""
expected-service-name	Optional expected service name used as a ranking hint and as the reported service name when resolution stays manual-review.	no	""
expected-api-ids-json	Optional JSON array of full resource names that this repository expects to own; exact matches rank highest during resolution.	no	[]
service-mapping-json	Optional JSON object mapping resource names to service names, used to name exported specs for label-incapable providers.	no	{}
output-dir	Directory under the repository root where generated specs are written.	no	discovered-specs
postman-api-key	Optional service-account PMAK used to mint or re-mint a postman-access-token for telemetry enrichment (account_type). Not used for any GCP or Postman asset operation.	no	""
postman-access-token	Optional Postman service-account access token, used only to enrich anonymous telemetry with the session account_type. When omitted, postman-api-key alone can mint one for the same purpose. Not used for any GCP or Postman asset operation.	no	""

Outputs

name	description
resolution-json	JSON resolution result describing status, source type, confidence, and evidence.
resolution-status	Resolution status: resolved or unresolved.
source-type	Resolved source type: repo-spec, api-gateway-config, cloud-endpoints-config, apigee-proxy, apigee-archive-deployment, api-hub-spec, api-hub-boosted-spec, api-hub-gateway-openapi-spec, apigee-registry-spec, app-integration-trigger, connectors-custom-spec, apigee-portal-doc, vertex-extension-manifest, dialogflow-tool-schema, ces-tool-schema, ces-toolset-schema, iac-embedded, manual-review, or discover-many.
mapping-confidence	Numeric confidence score for the selected service candidate.
spec-path	Path to the resolved or generated specification when available.
spec-files-json	Optional JSON inventory of the authoritative multi-file definition set (schemaVersion 1). Empty for single-file, unresolved, and discover-many results.
api-id	Full resource name of the exported cloud source (API Gateway config, Cloud Endpoints config, Apigee proxy revision, Apigee archive deployment, API Hub spec, legacy Apigee Registry spec, Apigee portal apidoc, Vertex extension, Dialogflow tool, or CES tool/toolset); empty for repo, generated, or IaC-local resolutions.
service-name	Resolved service name.
services-json	discover-many output: JSON array of exported services.
service-count	discover-many output: number of exported services.
export-summary-json	JSON summary of attempted, exported, failed, and skipped candidates.
candidates-json	Ranked ambiguous candidates as JSON when resolution is unresolved with at least two candidates; empty otherwise.
provider-type	Provider that produced the resolved spec: api-gateway, cloud-endpoints, apigee, api-hub, apigee-registry, app-integration, connectors-custom, apigee-portal, vertex-extensions, dialogflow-tools, ces-toolsets, or iac-local.
spec-format	Format of the resolved spec: openapi-yaml, openapi-json, asyncapi-yaml, asyncapi-json, graphql-sdl, graphql-introspection-json, protobuf, wsdl, or mcp-json.
contract-origin	Compatibility output; always empty in v1.
contract-metadata-path	Compatibility output; always empty in v1.
variant-count	Compatibility output; always empty in v1.
derived-openapi-path	Path to the derived OpenAPI 3.x document when the source was not already OpenAPI 3.x.
derived-openapi-version	OpenAPI version of the derived document: 3.0.3 or 3.1.0.
derived-openapi-completeness	Whether the derived OpenAPI document is full or partial.
derived-openapi-format	Serialization format of the derived OpenAPI document: openapi-json.
derived-openapi-evidence-json	JSON array of evidence strings describing how the derived OpenAPI document was produced.
narrowing-strategy	Narrowing tier that produced the candidate ordering: iac-fingerprint, project-correlation, label-prefilter, naming-heuristic, or none.