required-environment-information

Overview

This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:

To optimize agentic tools output, provide environment-specific details for each server defined in the OpenAPI document. This is best achieved using APIMatic's x-server-configuration extension, which helps distinguish production, staging, and other environments.

Property	Value
Enabled	No
Maximum Severity	Warning
Message	Include environment information for each server.
Code	OPENAPI3AGENTICTOOLS_L041
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Info
Products Impacted	Agentic Tools Generation, Code Generation, Developer Experience Portal
Tags	code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic info server environment x-server-configuration ServerConfiguration

Suggested Fixes

• Use APIMatic's extension x-server-configuration in Info Object to specify environment details for each server.
• If you are using APIMatic's metadata file, use ServerConfiguration object to define environment information.

For More Information

• https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/