API Key

DeveloperHub can integrate with your CI/CD pipelines to update pages and keep your references up to date.

Integrating with CI/CD

On running your CI/CD pipelines, you can upload a reference to DeveloperHub after generating it from your own tools. This works by:

  • Generating your reference.
  • Sending a request to DeveloperHub to update the reference.

If a reference with the same title already exists, then that reference will be updated. Otherwise, a new reference is created.

How to Upload References Programmatically

To upload references programmatically:

Create an API Key

To create an API Key for a project:

  • In the sidebar, select API Key
  • If you already have a key, then you can click on Copy to copy it.
  • If not, then you can generate a new API Key.

Each API Key can have different permissions. Consult the APIAPI to know which permissions you need.

Upload Reference through API

To upload the reference through the API, check Add or Update an API ReferenceAPI in our API Reference.

An example request would be:

Bash
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
  Last updated by Zaid Daba'een