OpenAPI Enhancer

Edit online

The OpenAPI Enhancer tool improves your APIs by generating intelligent recommendations for descriptions and examples. It also helps identify validation errors and potential issues that may affect API correctness.

The OpenAPI Enhancer tool communicates with the API Agent. After you enter a prompt and click Send in the API Agent, a proposed plan is displayed. To begin the specification enhancement or auto-correction of the OpenAPI, click Start. Once the process is finished, you can download the improved OpenAPI file.

Key highlights
  • Enhance your OpenAPI 3.0 documentation by generating recommendations for your descriptions and examples.
  • Improves your OpenAPI 3.0 specification through identifying validation errors and generating potential corrections.
The following operations are supported in the OpenAPI Enhancer tool:
Table 1. Parameters
Parameter Required Description Default
input_file No The OpenAPI specification in YAML or JSON format. None
api No The draft API name. None
version No The draft API version. None
file_format No The format of the generated OpenAPI file that is displayed, either JSON or YAML. YAML
oai_feature_type Yes Type of GenAI enhancement you want to perform, either suggest or autocorrect. None

Specification enhancements

Enhance your OpenAPI documentation by analyzing the API definition, and generating recommendations for your descriptions and examples.

Example prompts
Augment the following openapi with enhanced descriptions and examples @openapi-sample.yaml

or from a Draft API (with API name:version)

Augment the following openapi with enhanced descriptions and examples openapi-sample:1.0.0
Note: Select the required file, for example, openapi-sample.yaml. Entering @ after the prompt displays a list of OpenAPI documents available in your workspace.

Specification validation errors

Improve your APIs by analyzing your OpenAPI 3.0 specification, and generating potential API corrections for any validation errors.

Example prompts
Correct the validation errors in the following openapi file @openapi-sample.yaml

or from a Draft API (with API name:version)

Correct the validation errors in the following openapi file openapi-sample:1.0.0
Note: By default, the format of the augmented OpenAPI document is YAML. If you need your OpenAPI document to be in JSON format, specify it clearly in the prompt.

These API Agent capabilities are also available in the API Manager UI.