date-time-schema-format-with-string-type

Overview

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

The date-time format is only applicable to schemas with the type set to string. It seems that the date-time format has been used with an incompatible schema type.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	The format date-time is not applicable to the given schema type.
Code	OPENAPI3APIMATIC_L676
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Schemas
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting date-time schema type format string

Suggested Fixes

• Ensure that the schema type is set to string for compatibility with the date-time format.
• If the schema represents a different data type, consider using a compatible format or removing the date-time format.
• Ensure that the format used aligns with the schema's type and represents the desired data representation (e.g., date).

For More Information

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