Introducing A New OpenAPI Linting Ruleset for Agentic Tools Generation

We've introduced a new OpenAPI linting ruleset for Agentic Tools generation.

Details

As part of expanding our linting capabilities, We've introduced a new OpenAPI linting ruleset for Agentic Tools designed specifically to improve the quality of OpenAPI definitions used for agentic tool generation. This ruleset helps ensure that specifications are structured, descriptive, and optimized resulting in higher-quality AI tools and more reliable output.

Agentic Tools Linting Ruleset

This ruleset currently includes 10 linting rules, each focused on enriching and standardizing key areas of an OpenAPI document:

• Unique Tags Names
• Required Tag Description
• Required Info Object Description
• Required Environment Information for Servers
• Required Operation Summary
• Required Operation Description
• Required Parameter Description
• At Least One Parameter Example
• Required Schema Description
• Required Description for Enum

note

This ruleset is disabled by default. If you want to validate your OpenAPI definitions for agentic tools, you can enable it through your Validation Configuration settings.

Enabling the Agentic Tools Linting Ruleset

To enable the ruleset, add the following to your validation configuration in the APIMATIC-METADATA.json file:

{
    "ValidationConfiguration": {
        "Rulesets": {
            "openapi-v3-agentic-tools-linting":{
                "Rules": {
                    "EnableAll": true
                }
            }
        }
    }
}