This page applies to Apigee and Apigee hybrid.
Every API in API hub can have multiple versions, and each version can have a specification which can have multiple revisions. The History tab on the APIs page lists every specification revision across all versions of the API.
View API Registry schema
The following illustrates the relationships between API hub APIs, versions, deployments, and specifications.
Reference | Item | Description |
---|---|---|
Registry | A registry is a collection of APIs that serves as an API catalog. | |
Version | An API can have multiple versions. A version should correspond to a stable interface
that clients can use to call an API. One of these versions may be designated as the
recommended version. In semver terminology,
it is a best practice for versions to be major versions. |
|
Deployment | An API may have multiple deployments, e.g., different staging environments or regions. A deployment is a location (an address) where users can access an API. One of these deployments can be the recommended deployment. | |
Specification | It is recommended, but not required that an API version is described by formal specifications, often using different API specification formats. One of these specification formats can be primary, which indicates that other specs for this version are derived from it. | |
Revisions |
|
Sort revision table
Click the Updated column heading to sort the table.
Add revision
To add a revision:
In the Google Cloud console, go to the API hub page.
The APIs list page is displayed by default.
- From APIs list, click an API row. The Overview tab is displayed by default.
- Select the History tab.
- Click Add revision.
- Click Browse and then select a description document or zip file.
- Click Open.
- Specify Details:
- Select an API version.
- Select a MIME type. If you select Other, a text field is displayed where you can manually specify the MIME type.
- Type a Commit message (optional).
- Type a Commit hash (optional).
- Click Save (or Cancel).
View revision
See View or download a specificationDelete revision
To delete a revision:
In the Cloud console, go to the API hub page.
The APIs list page is displayed by default.
- From APIs list, click an API row. The Overview tab is displayed by default.
- Select the History tab.
- Click Delete next to the desired revision.
- Click Delete (or Cancel) at the prompt.