Skip to content

Latest commit

 

History

History

google-cloud-apigeeregistry

Google Cloud Platform logo

release level npm version

apigeeregistry client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Apigee Registry API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/apigee-registry

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Provisioning.create_instance source code Open in Cloud Shell
Provisioning.delete_instance source code Open in Cloud Shell
Provisioning.get_instance source code Open in Cloud Shell
Registry.create_api source code Open in Cloud Shell
Registry.create_api_deployment source code Open in Cloud Shell
Registry.create_api_spec source code Open in Cloud Shell
Registry.create_api_version source code Open in Cloud Shell
Registry.create_artifact source code Open in Cloud Shell
Registry.delete_api source code Open in Cloud Shell
Registry.delete_api_deployment source code Open in Cloud Shell
Registry.delete_api_deployment_revision source code Open in Cloud Shell
Registry.delete_api_spec source code Open in Cloud Shell
Registry.delete_api_spec_revision source code Open in Cloud Shell
Registry.delete_api_version source code Open in Cloud Shell
Registry.delete_artifact source code Open in Cloud Shell
Registry.get_api source code Open in Cloud Shell
Registry.get_api_deployment source code Open in Cloud Shell
Registry.get_api_spec source code Open in Cloud Shell
Registry.get_api_spec_contents source code Open in Cloud Shell
Registry.get_api_version source code Open in Cloud Shell
Registry.get_artifact source code Open in Cloud Shell
Registry.get_artifact_contents source code Open in Cloud Shell
Registry.list_api_deployment_revisions source code Open in Cloud Shell
Registry.list_api_deployments source code Open in Cloud Shell
Registry.list_api_spec_revisions source code Open in Cloud Shell
Registry.list_api_specs source code Open in Cloud Shell
Registry.list_api_versions source code Open in Cloud Shell
Registry.list_apis source code Open in Cloud Shell
Registry.list_artifacts source code Open in Cloud Shell
Registry.replace_artifact source code Open in Cloud Shell
Registry.rollback_api_deployment source code Open in Cloud Shell
Registry.rollback_api_spec source code Open in Cloud Shell
Registry.tag_api_deployment_revision source code Open in Cloud Shell
Registry.tag_api_spec_revision source code Open in Cloud Shell
Registry.update_api source code Open in Cloud Shell
Registry.update_api_deployment source code Open in Cloud Shell
Registry.update_api_spec source code Open in Cloud Shell
Registry.update_api_version source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Apigee Registry API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/apigee-registry@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE