@swamp/gcp/apigeeregistry
v2026.04.23.1
Google Cloud apigeeregistry infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudapigeeregistrycloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/apigeeregistry@swamp/gcp/apigeeregistry/apisv2026.04.23.1apis.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| availability? | string | A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN". |
| description? | string | A detailed description. |
| displayName? | string | Human-meaningful name. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys |
| name? | string | Resource name. |
| recommendedDeployment? | string | The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}` |
| recommendedVersion? | string | The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| apiId? | string | Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a apis
getGet a apis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apis |
updateUpdate apis attributes
deleteDelete the apis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apis |
syncSync apis state from GCP
Resources
state(infinite)— A top-level description of an API. Produced by producers and are commitments ...
@swamp/gcp/apigeeregistry/apis-artifactsv2026.04.23.1apis_artifacts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| contents? | string | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| mimeType? | string | A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). |
| name? | string | Resource name. |
| artifactId? | string | Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a artifacts
getGet a artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
deleteDelete the artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
syncSync artifacts state from GCP
get_contentsget contents
replace_artifactreplace artifact
| Argument | Type | Description |
|---|---|---|
| annotations? | any | |
| contents? | any | |
| createTime? | any | |
| hash? | any | |
| labels? | any | |
| mimeType? | any | |
| name? | any | |
| sizeBytes? | any | |
| updateTime? | any |
Resources
state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...
@swamp/gcp/apigeeregistry/apis-deploymentsv2026.04.23.1apis_deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessGuidance? | string | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. |
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| apiSpecRevision? | string | The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}` |
| description? | string | A detailed description. |
| displayName? | string | Human-meaningful name. |
| endpointUri? | string | The address where the deployment is serving. Changes to this value will update the revision. |
| externalChannelUri? | string | The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. |
| intendedAudience? | string | Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| name? | string | Resource name. |
| apiDeploymentId? | string | Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a deployments
getGet a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
updateUpdate deployments attributes
deleteDelete the deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
syncSync deployments state from GCP
list_revisionslist revisions
rollbackrollback
| Argument | Type | Description |
|---|---|---|
| revisionId? | any |
tag_revisiontag revision
| Argument | Type | Description |
|---|---|---|
| tag? | any |
Resources
state(infinite)— Describes a service running at particular address that provides a particular ...
@swamp/gcp/apigeeregistry/apis-deployments-artifactsv2026.04.23.1apis_deployments_artifacts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| contents? | string | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| mimeType? | string | A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). |
| name? | string | Resource name. |
| artifactId? | string | Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a artifacts
getGet a artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
deleteDelete the artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
syncSync artifacts state from GCP
get_contentsget contents
replace_artifactreplace artifact
| Argument | Type | Description |
|---|---|---|
| annotations? | any | |
| contents? | any | |
| createTime? | any | |
| hash? | any | |
| labels? | any | |
| mimeType? | any | |
| name? | any | |
| sizeBytes? | any | |
| updateTime? | any |
Resources
state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...
@swamp/gcp/apigeeregistry/apis-versionsv2026.04.23.1apis_versions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| description? | string | A detailed description. |
| displayName? | string | Human-meaningful name. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| name? | string | Resource name. |
| primarySpec? | string | The primary spec for this version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec} |
| state? | string | A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED". |
| apiVersionId? | string | Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a versions
getGet a versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
updateUpdate versions attributes
deleteDelete the versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
syncSync versions state from GCP
Resources
state(infinite)— Describes a particular version of an API. ApiVersions are what consumers actu...
@swamp/gcp/apigeeregistry/apis-versions-artifactsv2026.04.23.1apis_versions_artifacts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| contents? | string | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| mimeType? | string | A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). |
| name? | string | Resource name. |
| artifactId? | string | Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a artifacts
getGet a artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
deleteDelete the artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
syncSync artifacts state from GCP
get_contentsget contents
replace_artifactreplace artifact
| Argument | Type | Description |
|---|---|---|
| annotations? | any | |
| contents? | any | |
| createTime? | any | |
| hash? | any | |
| labels? | any | |
| mimeType? | any | |
| name? | any | |
| sizeBytes? | any | |
| updateTime? | any |
Resources
state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...
@swamp/gcp/apigeeregistry/apis-versions-specsv2026.04.23.1apis_versions_specs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| contents? | string | Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. |
| description? | string | A detailed description. |
| filename? | string | A possibly-hierarchical name used to refer to the spec from other specs. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| mimeType? | string | A style (format) descriptor for this spec that is specified as a [Media Type](https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compr |
| name? | string | Resource name. |
| sourceUri? | string | The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved. |
| apiSpecId? | string | Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a specs
getGet a specs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the specs |
updateUpdate specs attributes
deleteDelete the specs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the specs |
syncSync specs state from GCP
get_contentsget contents
list_revisionslist revisions
rollbackrollback
| Argument | Type | Description |
|---|---|---|
| revisionId? | any |
tag_revisiontag revision
| Argument | Type | Description |
|---|---|---|
| tag? | any |
Resources
state(infinite)— Describes a version of an API in a structured way. ApiSpecs provide formal de...
@swamp/gcp/apigeeregistry/apis-versions-specs-artifactsv2026.04.23.1apis_versions_specs_artifacts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| contents? | string | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| mimeType? | string | A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). |
| name? | string | Resource name. |
| artifactId? | string | Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a artifacts
getGet a artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
deleteDelete the artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
syncSync artifacts state from GCP
get_contentsget contents
replace_artifactreplace artifact
| Argument | Type | Description |
|---|---|---|
| annotations? | any | |
| contents? | any | |
| createTime? | any | |
| hash? | any | |
| labels? | any | |
| mimeType? | any | |
| name? | any | |
| sizeBytes? | any | |
| updateTime? | any |
Resources
state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...
@swamp/gcp/apigeeregistry/artifactsv2026.04.23.1artifacts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. |
| contents? | string | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. |
| labels? | record | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a |
| mimeType? | string | A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). |
| name? | string | Resource name. |
| artifactId? | string | Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a artifacts
getGet a artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
deleteDelete the artifacts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the artifacts |
syncSync artifacts state from GCP
get_contentsget contents
replace_artifactreplace artifact
| Argument | Type | Description |
|---|---|---|
| annotations? | any | |
| contents? | any | |
| createTime? | any | |
| hash? | any | |
| labels? | any | |
| mimeType? | any | |
| name? | any | |
| sizeBytes? | any | |
| updateTime? | any |
Resources
state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...
@swamp/gcp/apigeeregistry/instancesv2026.04.23.1instances.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| build? | object | Build information of the Instance if it's in `ACTIVE` state. |
| config? | object | Available configurations to provision an Instance. |
| name? | string | Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported. |
| instanceId? | string | Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a instances
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
deleteDelete the instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
syncSync instances state from GCP
Resources
state(infinite)— An Instance represents the instance resources of the Registry. Currently, onl...
@swamp/gcp/apigeeregistry/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
Resources
state(infinite)— A resource that represents a Google Cloud location.
2026.04.03.340.3 KBApr 3, 2026
Google Cloud apigeeregistry infrastructure models
Release Notes
- Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapigeeregistrycloudinfrastructure
2026.04.03.139.2 KBApr 3, 2026
Google Cloud apigeeregistry infrastructure models
Release Notes
- Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapigeeregistrycloudinfrastructure
2026.04.02.239.1 KBApr 2, 2026
Google Cloud apigeeregistry infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapigeeregistrycloudinfrastructure
2026.03.27.135.0 KBMar 27, 2026
Google Cloud apigeeregistry infrastructure models
Release Notes
- Added: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapigeeregistrycloudinfrastructure