Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

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.

npm version

Developer Connect 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 Developer Connect API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/developerconnect

Samples

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

Sample Source Code
create account connector source code
create connection source code
create git repository link source code
delete account connector source code
delete connection source code
delete git repository link source code
delete self source code
delete user source code
fetch access token source code
fetch git hub installations source code
fetch git refs source code
fetch linkable git repositories source code
fetch read token source code
fetch read write token source code
fetch self source code
finish o auth source code
get account connector source code
get connection source code
get git repository link source code
list account connectors source code
list connections source code
list git repository links source code
list users source code
start o auth source code
update account connector source code
update connection source code
create insights config source code
delete insights config source code
get deployment event source code
get insights config source code
list deployment events source code
list insights configs source code
update insights config source code
cloud 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/developerconnect@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