search

json-schema-org / json-schema-spec

The JSON Schema specification
http://json-schema.org/
Other
3.82k stars 266 forks source link

array not required returns the message: "1 item required; only 0 were given" in the json schema #1275

Closed valeriaA closed 2 years ago

valeriaA commented 2 years ago

I configured the json schema and it looked like this:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "organisationId": {
          "type": "string"
        },
        "clientId": {
          "type": "string"
        },
        "issuer": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "createdDate": {
          "type": "string",
          "format": "date-time"
        },
        "lastModifiedDate": {
          "type": "string",
          "format": "date-time"
        },
        "consentId": {
          "type": "string"
        },
        "internalStatus": {
          "type": "string",
          "enum": [
            "AUTHORISED",
            "AWAITING_AUTHORISATION",
            "REJECTED",
            "TIMEOUT_EXPIRED",
            "OVERDUE",
            "REVOKED"
          ]
        },
        "permissions": {
          "type": "array",
          "items": [
            {
              "type": "string"
            }
          ]
        },
        "approverType": {
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "AUTHORISED",
            "AWAITING_AUTHORISATION",
            "REJECTED",
            "REVOKED",
            "CONSUMED"
          ]
        },
        "statusUpdateDateTime": {
          "type": "string",
          "format": "date-time"
        },
        "expirationDateTime": {
          "type": "string",
          "format": "date-time"
        },
        "resourceGroups": {
          "uniqueItems": true,
          "oneOf": [
            {
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "items": [
            {
              "type": "object",
              "properties": {
                "resourceGroupId": {
                  "type": "integer"
                },
                "permissions": {
                  "type": "array",
                  "items": [
                    {
                      "type": "string"
                    }
                  ]
                },
                "resources": {
                  "type": "array",
                  "uniqueItems": true,

                  "items": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "AVAILABLE",
                            "UNAVAILABLE",
                            "TEMPORARY_UNAVAILABLE",
                            "PENDING_AUTHORISATION"
                          ]
                        },
                        "additionalInfos": {
                          "type": "array",
                          "items": [
                            {
                              "type": "object",
                              "properties": {
                                "key": {
                                  "type": "string"
                                },
                                "value": {
                                  "type": "string"
                                }
                              }
                            }
                          ]
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "CUSTOMERS_PERSONAL_IDENTIFICATIONS",
                            "CUSTOMERS_PERSONAL_QUALIFICATION",
                            "CUSTOMERS_PERSONAL_ADITTIONALINFO",
                            "CUSTOMERS_BUSINESS_IDENTIFICATIONS",
                            "CUSTOMERS_BUSINESS_QUALIFICATION",
                            "CUSTOMERS_BUSINESS_ADITTIONALINFO",
                            "CAPITALIZATION_TITLES",
                            "PENSION",
                            "DAMAGES_AND_PEOPLE_PATRIMONIAL",
                            "DAMAGES_AND_PEOPLE_AERONAUTICAL",
                            "DAMAGES_AND_PEOPLE_NAUTICAL",
                            "DAMAGES_AND_PEOPLE_NUCLEAR",
                            "DAMAGES_AND_PEOPLE_OIL",
                            "DAMAGES_AND_PEOPLE_RESPONSABILITY",
                            "DAMAGES_AND_PEOPLE_TRANSPORT",
                            "DAMAGES_AND_PEOPLE_FINANCIAL_RISKS",
                            "DAMAGES_AND_PEOPLE_RURAL",
                            "DAMAGES_AND_PEOPLE_AUTO",
                            "DAMAGES_AND_PEOPLE_HOUSING",
                            "DAMAGES_AND_PEOPLE_PEOPLE",
                            "DAMAGES_AND_PEOPLE_ACCEPTANCE_AND_BRANCHES_ABROAD"
                          ]
                        },
                        "hidden": {
                          "type": "boolean"
                        },
                        "resourceId": {
                          "type": "string"
                        }
                      }
                    }
                  ]
                },
                "additionalInfos": {
                  "type": "array",
                  "items": [
                    {
                      "type": "object",
                      "properties": {
                        "key": {
                          "type": "string"
                        },
                        "value": {
                          "type": "string"
                        }
                      }
                    }
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "ACCOUNT",
                    "CREDIT_CARD_ACCOUNT",
                    "LOAN",
                    "INVOICE_FINANCING",
                    "UNARRANGED_ACCOUNT_OVERDRAFT",
                    "FINANCING",
                    "RESOURCE",
                    "CUSTOMER"
                  ]
                }
              },
              "required": [
                "permissions",
                "type"
              ]
            }
          ]
        },
        "approvers": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "AUTHORISED",
                    "AWAITING_AUTHORISATION",
                    "REJECTED",
                    "REVOKED",
                    "CONSUMED"
                  ]
                },
                "approverId": {
                  "type": "string"
                }
              },
              "required": [
                "approverId"
              ]
            }
          ]
        },
        "loggedUser": {
          "type": "object",
          "properties": {
            "document": {
              "type": "object",
              "properties": {
                "identification": {
                  "type": "string"
                },
                "rel": {
                  "type": "string"
                }
              },
              "required": [
                "identification",
                "rel"
              ]
            }
          },
          "required": [
            "document"
          ]
        },
        "businessEntity": {
          "type": "object",
          "properties": {
            "document": {
              "type": "object",
              "properties": {
                "identification": {
                  "type": "string"
                },
                "rel": {
                  "type": "string"
                }
              },
              "required": [
                "identification",
                "rel"
              ]
            }
          },
          "required": [
            "document"
          ]
        }
      },
      "required": [
        "organisationId",
        "clientId",
        "consentId",
        "permissions",
        "approverType",
        "status",
        "statusUpdateDateTime",
        "expirationDateTime",
        "loggedUser"
      ]
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string"
        },
        "first": {
          "type": "string"
        },
        "prev": {
          "type": "string"
        },
        "next": {
          "type": "string"
        },
        "last": {
          "type": "string"
        }
      },
      "required": [
        "self"
      ]
    },
    "meta": {
      "type": "object",
      "properties": {
        "totalRecords": {
          "type": "integer"
        },
        "totalPages": {
          "type": "integer"
        }
      },
      "required": [
        "totalRecords",
        "totalPages"
      ]
    }
  }
}

Note that the "resources" array is not required, it is not mandatory.

However... when I run my test and it returns an empty array in "resources":

"resourceGroupId":1,
      "permissions":[
         "CUSTOMERS_PERSONAL_QUALIFICATION_READ",
         "CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ"
      ],
      "resources":[],
      "type":"CUSTOMER"
   }

I get the following message:

"#/data/resourceGroups/0/resources: failed schema #/properties/data/properties/resourceGroups/items/0/properties/resources: 1 item required; only 0 were supplied."

I don't understand how 1 item is required if the array is not required.

and still have( "uniqueItems": true )

which in theory would accept a [] in the return, according to the Json schema documentation.

I've tried passing minItems=0 and many other things and nothing has worked.

handrews commented 2 years ago
  1. This is the spec repo, you need to file this with the implementation's repository.
  2. Did you mean to use the array form of items? {"items": [{...}]} applies the {...} schema only to the first element of the array. {"items": {...}} applies the {...} schema to all elements of the array.
  3. Even if you did mean to use the array form of items, that shouldn't make the one element required. Only "minItems": 1 should do that, so that's probably a bug in the implementation (which we can't help you with)
valeriaA commented 2 years ago

@handrews

I can't find the repository you mentioned (implementation repository) can you give me the link please?

Thank you!

gregsdennis commented 2 years ago

@valeriaA we'll need to know what implementation you're using. Please have a look at https://json-schema.org/implementations.html. This lists all of the implementations we know about and contains links to them.

gregsdennis commented 2 years ago

Also, I see that you've asked the question on StackOverflow. Please allow time for the community to answer there before reposting your question elsewhere.