Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix enum validation type 'array', add path to error for nested props, fix cast for the case when 'type' is an array #44

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

Leonidaz
Copy link

fix a few issues:

fix enum validation when attribute is of type 'array'
before the fix indexOf was used to compare the whole value of the field but since the value is an array ['item1', 'item2'], it would end up looking for the whole piece ['item1', 'item2'] instead of examing each item in the value array.

add path to error object for nested properties, so that the name of the property contains the parent name and its property name

fix cast for the case when 'type' is an array; change string comparison to indexOf search that works both for strings and arrays

fix enum validation when attribute is of type 'array'
before the fix indexOf was used to compare the whole value of the field but since the value is an array ['item1', 'item2'], it would end  up looking for the whole piece ['item1', 'item2'] instead of examing each item in the value array.
add path to error object for nested properties, so that the name of the property contains the parent name and its property name:

    parent{
        properties{
            verify: {
                properties:{
                    email: {
                        description: 'Verify Email Address',
                        'type': 'string',
                        format: 'email',
                        required: true,
                        maxLength: 200,
                    },
                    file: {
                        description: 'Upload Document',
                        'type': 'string',
                        required: true,
                        maxLength: 250
                    }
                }
            }
        }
    }

with errors containing path for each nested property:

    {
      "valid": false,
      "errors": [
        {
          "attribute": "format",
          "property": "email",
          "expected": "email",
          "actual": "dfdfd",
          "message": "is not a valid email",
          "path": "verify.email"
        },
        {
          "attribute": "required",
          "property": "file",
          "expected": true,
          "message": "is required",
          "path": "verify.file"
        }
      ]
    }
fix cast for the case when 'type' is an array
change string comparison to indexOf search that works both for strings and arrays
…ype 'object' and of type 'array' with 'items'

if a property has children (child schemas) and this property is missing then the children would not get checked.  If the children, for example, are required those errors would never show up. This makes sure that all errors on all child properties are returned. In most case the parent is just a holder for the child properties and if it's missing it's not that interesting to know that it's missing but if its children are missing, which may correspond for form fields, it would be very useful to know since the focus was initially on the child fields.
@nielskrijger
Copy link

Hopefully this merge request is acccepted in a future version; I'm having problems with ambiguous attribute names because attributes do not include parent names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants