This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.
Apigee Registry API 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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Apigee Registry API API.
- Set up authentication 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 |
|---|---|
| create instance | source code |
| delete instance | source code |
| get instance | source code |
| create api | source code |
| create api deployment | source code |
| create api spec | source code |
| create api version | source code |
| create artifact | source code |
| delete api | source code |
| delete api deployment | source code |
| delete api deployment revision | source code |
| delete api spec | source code |
| delete api spec revision | source code |
| delete api version | source code |
| delete artifact | source code |
| get api | source code |
| get api deployment | source code |
| get api spec | source code |
| get api spec contents | source code |
| get api version | source code |
| get artifact | source code |
| get artifact contents | source code |
| list api deployment revisions | source code |
| list api deployments | source code |
| list api spec revisions | source code |
| list api specs | source code |
| list api versions | source code |
| list apis | source code |
| list artifacts | source code |
| replace artifact | source code |
| rollback api deployment | source code |
| rollback api spec | source code |
| tag api deployment revision | source code |
| tag api spec revision | source code |
| update api | source code |
| update api deployment | source code |
| update api spec | source code |
| update api version | source code |
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.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
License
Apache Version 2.0
See LICENSE