number-boundaries-defined

Overview

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

Numeric schemas should have both a minimum and maximum boundary defined in OpenAPI 3.0 specifications.

Property	Value
Enabled	No
Maximum Severity	Warning
Message	Numeric schema boundaries are not defined.
Code	OPENAPI3APIMATIC_L680
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Schemas
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting number boundaries minimum maximum schema

Suggested Fixes

• Check the OpenAPI 3.0 specification to confirm if minimum and maximum boundaries are specified for the numeric schema.
• If either the minimum or maximum boundary is missing, add the missing boundary to the schema definition.
• Make sure that the minimum and maximum boundaries are specified with appropriate data types (e.g., integer or number) in the schema definition.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#schema-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/