Convert OpenAPI schema "example" to "examples" array

[kalxas]

It has been reported that some tools that convert OpenAPI schemas to JSONSchema have an issue converting example to examples.

ESA-EarthCODE/open-science-catalog-metadata#233 (comment)
ESA-EarthCODE/open-science-catalog-metadata#233 (comment)
ESA-EarthCODE/open-science-catalog-metadata#233 (comment)
ESA-EarthCODE/open-science-catalog-metadata#233 (comment)

Should we consider switching the YAML schema example to examples to avoid doing it manually during conversion?

[pvretano]

@kalxas I'll update all instances of "example" to be "examples'. I just checked the JSON Schema specification and it seems that the correct key name is "examples".

[kalxas]

@pvretano thank you

[pvretano]

OK ... the change from "example" to "examples" causes validation of the example openAPI files to fail so I have to undo these changes. For example, when I changes all instances of "example" in linkBase.yaml to "examples" (and converted the example to an array) swagger-cli spewed forth a long list of "additional parameters not allowed" errors. I think this is because the version of JSON schema that swagger-cli understands is not pure JSON schema.

[kalxas]

ok, let's revert then

[m-mohr]

Interesting, especially given that OpenAPI 3.1 deprecates example in favor of examples:

Deprecated: The example property has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.