You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Here is a compilation of the issues with v2.yml that prevent it from complying with OpenAPI 3.1.0.
Invalid JSON schemas
items
There are 550+ places where a schema has the items field set to an array. This is incorrect for JSON draft 2020-12,
and it should be a single schema value.
I think the intention is to have this be a oneOf, but I'm not certain.
items:
- fieldName:
description: Form field nametype: stringexample: First NamefieldType:
description: Form field typetype: stringenum:
- FormTextInput
- FormTextarea
- FormCheckboxInput
- FormRadioInput
- FormFileUploadInputexample: FormTextInputfieldElementId:
description: Element ID of the Form Fieldtype: stringformat: UUIDexample: 285042f7-d554-dc7f-102c-aa10d6a2d2c4
This one is just a single schema, so it just needs to be un-arrayed.
examples
At paths -> /collections/{collection_id}/items/bulk -> post -> requestBody -> content -> application/json, the schema
has an invalid examples field. It's set to a map, but for JSON schema 2020-12, it should be an array examples. Example
maps are for the higher-up, Open API-specific objects, not JSON schemas.
The offending code:
examples:
SingleItemMultipleLocales:
summary: Create a single item across multiple localesvalue:
cmsLocaleIds:
- 66f6e966c9e1dc700a857ca3
- 66f6e966c9e1dc700a857ca4
- 66f6e966c9e1dc700a857ca5isArchived: falseisDraft: falsefieldData:
name: Don’t Panicslug: dont-panicMultipleItemsMultipleLocales:
summary: Create multiple items across multipel localesvalue:
cmsLocaleIds:
- 66f6e966c9e1dc700a857ca3
- 66f6e966c9e1dc700a857ca4isArchived: falseisDraft: falsefieldData:
- name: Don’t Panicslug: dont-panic
- name: So Long and Thanks for All the Fishslug: so-long-and-thanks
Another instance where this happens is at webhooks -> collection_item_created -> post -> requestBody -> content -> application/json -> schema:
At paths -> /sites/{site_id}/products/{product_id}/skus -> post -> responses -> 200 -> content -> application/json -> schema -> properties,
there is a required field that I think is supposed to be up a level as a property of the schema itself.
Here is a compilation of the issues with
v2.yml
that prevent it from complying with OpenAPI 3.1.0.Invalid JSON schemas
items
There are 550+ places where a schema has the
items
field set to an array. This is incorrect for JSON draft 2020-12,and it should be a single schema value.
Most of the instances look like:
I think the intention is to have this be a
oneOf
, but I'm not certain.This one is just a single schema, so it just needs to be un-arrayed.
examples
At
paths -> /collections/{collection_id}/items/bulk -> post -> requestBody -> content -> application/json
, the schemahas an invalid
examples
field. It's set to a map, but for JSON schema 2020-12, it should be an array examples. Examplemaps are for the higher-up, Open API-specific objects, not JSON schemas.
The offending code:
Another instance where this happens is at
webhooks -> collection_item_created -> post -> requestBody -> content -> application/json -> schema
:required
At
paths -> /sites/{site_id}/products/{product_id}/skus -> post -> responses -> 200 -> content -> application/json -> schema -> properties
,there is a
required
field that I think is supposed to be up a level as a property of theschema
itself.The offending code:
The text was updated successfully, but these errors were encountered: