OAS 3.1 drops a few string formats that used to be added on top of JSON Schema; at the same time, the newer version of JSON Schema defines many more formats than I used to include in the builtin list of string formats. A couple of the OAS 3.0 formats were replaced with JSON Schema contentEncodings in OAS 3.1
Breaking
There are no breaking changes to the OpenAPIKit30 module. The following all apply to the OpenAPIKit module.
There is no longer .extended formats for .string JSON Schemas. Instead, all existing .extended formats are now just regular .string formats (e.g. you can just replace .extended(.uuid) with .uuid).
There are no longer .byte or .binary formats for .string JSON Schemas. Instead, use the contentEncodings of .base64 and .binary, respectively.
The .uriReference.extended JSON Schema .string format used to serialize to uriref whereas the new .uriReference JSON Schema .string format serializes to uri-reference, per the JSON Schema standard.
Closes https://github.com/mattpolzin/OpenAPIKit/issues/332 Closes https://github.com/mattpolzin/OpenAPIKit/issues/336
OAS 3.1 drops a few string formats that used to be added on top of JSON Schema; at the same time, the newer version of JSON Schema defines many more formats than I used to include in the builtin list of string formats. A couple of the OAS 3.0 formats were replaced with JSON Schema
contentEncodings in OAS 3.1Breaking
There are no breaking changes to the
OpenAPIKit30module. The following all apply to theOpenAPIKitmodule..extendedformats for.stringJSON Schemas. Instead, all existing.extendedformats are now just regular .stringformats (e.g. you can just replace.extended(.uuid)with.uuid)..byteor.binaryformats for.stringJSON Schemas. Instead, use thecontentEncodings of.base64and.binary, respectively..uriReference.extendedJSON Schema.stringformat used to serialize tourirefwhereas the new.uriReferenceJSON Schema.stringformat serializes touri-reference, per the JSON Schema standard.