Specification boost add-on

This page applies to Apigee and Apigee hybrid.

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Specification boost is an AI-powered add-on that lets you automatically enhance the readability and discoverability of your API specifications in API hub. It analyzes your existing specification files and generates boosted versions enriched with richer details, including additional examples, clearer descriptions, better error documentation, and more.

A key benefit of using the specification boost add-on is that it makes your specification files agent ready. Boosting your specifications makes them more accessible to developers, API consumers, and AI agents.

Note: AI can make mistakes. Review all boosted specifications carefully before using them in production.

Enable specification boost

To start using specification boost, you must first enable and configure it in the Add-on management page in API hub.

Note: Specification boost add-on enablement can take 10 minutes to complete.

Before you begin

• Grant the API hub Add-on Admin (roles/apihub.addonsAdmin) IAM role to your principal account. For information about granting IAM roles, see Grant or revoke multiple IAM roles using the Google Cloud console.

Console

To enable the specification boost add-on, do the following:

1. In the Google Cloud console, go to the API hub > Add-on management page.

   Go to Add-on management

2. Locate the Specification boost add-on card and click Enable add-on.

   Enabling the add-on triggers an asynchronous operation that automatically processes and boosts all your API specification files in API hub.

View boosted specifications

Boosted specifications are generated asynchronously. Depending on the number of specification files and their size, it may take some time for the asynchronous operation to complete. Once the asynchronous operation completes, you can view the boosted specifications as an additional version of the original specification.

Note: Specification boost doesn't overwrite any of your original specification files. All boosted versions of a specification file are created as versions of the same specification file.

Console

To view the boosted specification files, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub
2. Click APIs.
3. Use Filter to specify keywords to filter the list of APIs. If needed, use Search to locate an API.
4. Click an API to view its details.
5. Go to the Versions tab, and select the API version for which you want to view the boosted specifications.
6. Scroll to the Specification file section to view the list of specifications linked to the version.

   The Boosted specification column displays the boosted specification files if they are available.

7. To view the details of a boosted specification, click the name of the boosted specification file.

   

8. To see the differences in the boosted spec, click View diff in the tridot menu in the row for that specification file.

Disable specification boost

To disable the specification boost add-on, do the following:

Note: Disabling the specification boost add-on doesn't delete any boosted specifications that you have already generated.

Console

To disable the specification boost add-on, do the following:

1. In the Google Cloud console, go to the API hub > Add-on management page.

   Go to Add-on management

2. Locate the Specification boost add-on card and click Disable add-on.
3. In the Disable specification boost confirmation dialog, enter disable, and then click Disable.

   The specification boost add-on is disabled in a few minutes.

Considerations

• AI can make mistakes. Review all boosted specifications carefully before using them in production.
• Boosted specifications are generated asynchronously. Depending on the number of specification files and their size, it may take some time for the asynchronous operation to complete.
• Once the add-on is enabled, any new or updated specification file is automatically boosted asynchronously.

Limitations

• You can't select specific specification files to boost. All specification files are boosted asynchronously after the add-on is enabled.
• Specification boost doesn't support replacing or merging the boosted content into your original specification file.
• At this time, specification boost is not available for customers using VPC-SC.

What's next

• Learn about API specifications.
• Learn about API versions.