adewg / ICAR

Standard messages and specifications for animal data exchange in livestock.
https://icar.org/
Apache License 2.0
46 stars 26 forks source link

Update to OpenAPI version 3.1 #438

Closed cookeac closed 4 months ago

cookeac commented 9 months ago

Update to OpenAPI 3.1

The following changes have been made to all OpenAPI files in the url-schemes folder:

The following changes have been made to JSON Schema files in the types and resources folders where "nullable": true was previously specified:

Where a complex type (imported with "$ref" was previously nullable):

These last changes appear in examples online, but they are the ones that are most likely to interrupt code generation. Please test.

Resolves https://github.com/adewg/ICAR/issues/239

cookeac commented 9 months ago

A further note - until it is merged, this PR will fail Speccy validation. This is because Speccy is deprecated and does not support OpenAPI 3.1. When this PR is merged, it will remove the GitHub action for Speccy, leaving us with Spectral validation.

cookeac commented 5 months ago

We agreed (meeting 2024-04-04) that we could merge this once #451 is addressed with a PR, as @AlexeyHardCode has tested code generation with C# at least.