Regex for JSON schema

Question

How to add regex validation for a json schema where the attribute is getting created on the fly and in the format of api pattern and can only contain all upper/lower alphabets, digits, slashes (/) and curly braces {}

E.g:

/someapi/v1/{usename}

/someApi/v1/{userName}

Here is my Uschema:

     {
      "type": "object",
      "patternProperties": {
       "^[a-zA-Z0-9{}/]": {
         "additionalProperties": false,
         "type": "object",
         "patternProperties": {
           "^(EMP|MGR|ACCT)$": {
            "additionalProperties": false,
            "type": "object"
          }
        }
     }
   }
 }

and here is the JSON and the results using ajv (spec 7)

My JSON Sample:

{"/employee/v1/{empId}":{"EMP":{}}} - PASS
{"/employee/v1/{empId}":{"E1MP":{}}} - FAIL (I can understand as E1MP is there)
{"/employee/v1/{empId}/<fooBar>":{"E1MP":{}}} - FAIL 
(I can understand as E1MP is there but didn't complain about < > 
brackets as it was the first entry to validate)

{"/employee/v1/{empId}/<fooBar>":{"EMP":{}}} - PASS (?)
(Actually it should FAIL ???, Why it is considering the < > brackets though I have the regex in place for the outer parent property.)

Also, if I tweak the outer regex to validate any empty space like: ^[a-zA-Z0-9{}/\s], it wont complain any error for the spaces:

{"/emp loye  e/v1/{empI   d}/{f  ooBar}":{"EMP":{}}} -- PASS? (Actually it shoud FAIL ???)

You have the right approach but you’re missing how the subschemas are applied. I’ll try to provide you with a solution this evening =] — Relequestual
– Relequestual, Commented Dec 28, 2019 at 16:26
Thanks for reverting. In the meantime, how should I understand your phrase of your comment 'how the subschemas are applied' ? — user8479984
– user8479984, Commented Dec 28, 2019 at 17:28
I have updated to bring more clarity. Sorry for any inconvenience — user8479984
– user8479984, Commented Dec 29, 2019 at 4:24

Relequestual · Accepted Answer · 2020-01-02 11:46:46Z

2

There are two problems with your schema.

First, the regex's are not anchored by default. You need to anchor them. Your first regex is not fully anchored.

Second, even when it's fully anchored, you didn't disallow additional properties.

Here's an updated schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "additionalProperties": false,
  "patternProperties": {
    "^[a-zA-Z0-9{}/]+$": {
      "additionalProperties": false,
      "type": "object",
      "patternProperties": {
        "^(EMP|MGR|ACCT)$": {
          "additionalProperties": false,
          "type": "object"
        }
      }
    }
  }
}

Now, any property of the object which doesn't match the regex will cause a validation error as you expect.

edited Jan 2, 2020 at 11:46

answered Dec 30, 2019 at 16:37

Relequestual

12.4k7 gold badges52 silver badges87 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

user8479984 Over a year ago

Thanks for that. However it is not validating this json: {"/employee/v1/{empId}":{"EMP":{}}}. Also, not sure how to address space validation.

Relequestual Over a year ago

I've amended the regex to work as you expect. Needed to add a repeat.

Relequestual Over a year ago

What do you mean by "handle address space validation"?

user8479984 Over a year ago

I was mentioning about validating spaces in the API key. But I have checked now and its seems, it also got fixed after the amendment. So in nutshell, the regex is now validating: upper/lower alphabets, digits, slashes (/), curly braces {} and No Spaces in the key. Thanks it is now working as expected.

Relequestual Over a year ago

You're welcome. If you have any JSON Schema questions which don't fit on StackOverflow, feel free to join our open slack via the website.

Collectives™ on Stack Overflow

Regex for JSON schema

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related