OpenAPI Schema Properties DateTime Naming (Edit)

DateTime properties (format date-time) should include a temporal suffix such as At, Date, Time, or On to clearly communicate that the value represents a point in time.

OpenAPISchemaPropertiesNamingDateTime

Rule Definition

openapi-schema-properties-datetime-naming-warn.yaml 
{"openapi-schema-properties-datetime-naming-warn":{"description":"DateTime properties (format date-time) should include a temporal suffix such as At, Date, Time, or On to clearly communicate that the value represents a point in time.","message":"DateTime properties SHOULD use a temporal suffix (At, Date, Time, On).","given":"$..[?(@.format==\"date-time\")]~","severity":"warn","then":{"function":"pattern","functionOptions":{"match":"(?i)(At|Date|Time|On|Timestamp)$"}}}}

Back to All of the Rules