Swagger validation which was working fine on 12th Feb is now failing validation for type: string, when it contains an example date as value

Example Swagger/OpenAPI definition:

                    "DateOfDelivery": {
                      "example": "2019-09-26",
                      "type": "string"
                    },

Describe the bug you’re encountering

The above is part of my swagger spec, and is getting validated ok in editor.swagger.io

We have release pipelines configured. The task ‘API Management - Create or Update API’ is used in the azure devops portal to configure the web api. The task’s field ‘Definition Artifact’ is given the path of the swagger spec file.

The pipeline was running OK since November 2019 until around 12th Feb 2020. Since around 13th Feb we started to get validation errors when the pipeline runs.

Error:

2020-02-14T12:21:06.8150207Z Data and type mismatch found. [#/paths/~1order-product/post/responses/200/content/application~1json/schema/properties/DateOfDelivery/example]
@{code=ValidationError; target=representation; message=Parsing error(s): The input OpenAPI file is not valid for the OpenAPI specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md (schema https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.yaml).}

Expected behavior

No errors

[nachiketrss]

@VitaliyKurokhtin - can you give me more detail as to what caused the issue and how/when it got resolved please.

[michaeltnguyen]

Hi, this is related to https://github.com/Azure/api-management-developer-portal/issues/294. We had the same problem with date-only examples like you have. The workaround is to have the type be a “date-time”. (this is wrong, but will allow your API to be imported).

The underlying bug is in Microsoft’s implementation of OpenApi reader, which has gone unfixed for a very long time.

microsoft/OpenAPI.NET#407 microsoft/OpenAPI.NET#420 <-- specifically about dates https://github.com/microsoft/OpenAPI.NET/issues/429