Back to Google Cloud Node

[API hub API: Nodejs Client][homepage]

packages/google-cloud-apihub/README.md

0.57.019.7 KB
Original Source

API hub API: Nodejs Client

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.

API hub 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

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

Installing the client library

bash
npm install @google-cloud/apihub

Samples

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

SampleSource Code
create apisource code
create api operationsource code
create attributesource code
create deploymentsource code
create external apisource code
create specsource code
create versionsource code
delete apisource code
delete api operationsource code
delete attributesource code
delete deploymentsource code
delete external apisource code
delete specsource code
delete versionsource code
get apisource code
get api operationsource code
get attributesource code
get definitionsource code
get deploymentsource code
get external apisource code
get specsource code
get spec contentssource code
get versionsource code
list api operationssource code
list apissource code
list attributessource code
list deploymentssource code
list external apissource code
list specssource code
list versionssource code
search resourcessource code
update apisource code
update api operationsource code
update attributesource code
update deploymentsource code
update external apisource code
update specsource code
update versionsource code
collect api datasource code
create curationsource code
delete curationsource code
get curationsource code
list curationssource code
update curationsource code
create dependencysource code
delete dependencysource code
get dependencysource code
list dependenciessource code
update dependencysource code
get discovered api observationsource code
get discovered api operationsource code
list discovered api observationssource code
list discovered api operationssource code
create pluginsource code
create plugin instancesource code
delete pluginsource code
delete plugin instancesource code
disable pluginsource code
disable plugin instance actionsource code
enable pluginsource code
enable plugin instance actionsource code
execute plugin instance actionsource code
get pluginsource code
get plugin instancesource code
list plugin instancessource code
list pluginssource code
update plugin instancesource code
create host project registrationsource code
get host project registrationsource code
list host project registrationssource code
get style guidesource code
get style guide contentssource code
lint specsource code
update style guidesource code
create api hub instancesource code
delete api hub instancesource code
get api hub instancesource code
lookup api hub instancesource code
create runtime project attachmentsource code
delete runtime project attachmentsource code
get runtime project attachmentsource code
list runtime project attachmentssource code
lookup runtime project attachmentsource code
cloudsource 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/apihub@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