Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Users Search
Help Dashboard Sign In Sign Up
Q&A Code Reviews Meta
Q&A
Posts Tags Edits
Ask Question

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Comments on Validate All Object Properties with JSON Schema

Post

Validate All Object Properties with JSON Schema

+5
−0

I'm writing a JSON schema to validate asset files for a program. The JSON I need to parse is structured so:

{
  "jobs": {
    "software-developer": { "job-description": "sw-dev.md:0", "pay": 80000 },
    "sales-bro": { "job-description": "sales-bro", "pay": 190000 }
  },
  "people": {
    "alice": { "name": "Alice", "profile-pic": "profile-alice.jpg:0" },
    "bob": { "name": "Bob", "profile-pic": "bob.png:0" }
  }
}

As you can see, each sub-object of a primary group follows a very deterministic pattern, but the top-level object keys vary based on the id of the asset being described. In this format, things like alice, bob, and sales-bro aren't being treated as object properties, but more like identifiers.

Is there a way in JSON schema to validate such a scheme? Can I create a rule that validates the values corresponding to every key within an object?

{
  "$schema": "https://json-schema.org/draft-04/schema",
  "$id": "https://example.com/my-assets.json",
  "title": "Assets",
  "type": "object",
  "properties": {
    "jobs": {
      "type": "object",
      "each-property": { // <--- dubious
        "type": "object",
        "properties": {
          "job-description": ...,
          "pay": ...
        }
      }
    },
    "people": {
      // etc...
    }
  }
}
json validation
posted over 3 years ago
CC0
user card
Josh Hyatt‭
137 reputation 5 0 27 2
History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.
Why should this post be closed?

1 comment thread

General comments (5 comments)
General comments
elgonzo‭ wrote over 3 years ago · edited over 3 years ago
copy link

Just a rough idea from the top of my head (untested, unverified, might be bogus). You could perhaps use the "patternProperties" keyword, with which you would specify a regex pattern against which property names are being matched. Since in your case the property names in "jobs" and "people" don't matter at all wrt validation, a simple regex like .+ might perhaps do the trick (see also https://json-schema.org/draft/2020-12/json-schema-core.html#rfc.section.10.3.2.2)

elgonzo‭ wrote over 3 years ago · edited over 3 years ago
copy link

If your identifiers have to satisfy some specification wrt to format and/or allowed characters, you might construct the regex pattern(s) in way that they match the specification, and additionally employ the "additionalProperties" keyword that uses the "false" schema to fail validation if any properties do not match the defined regex pattern(s). (I don't like to write this as answer, as i have not verified anything of what i just said...)

Josh Hyatt‭ wrote over 3 years ago
copy link

@elgonzo Would you go ahead and post this as an answer while I verify it? This looks like exactly what I was asking for.

elgonzo‭ wrote over 3 years ago
copy link

I would prefer to have this verified first. Not that it turns out that my idea, while sounding good, is actually not being workable. Wouldn't be the first time... ;)

Josh Hyatt‭ wrote over 3 years ago
copy link

@elgonzo I've verified your idea. I've defined a regex that I want to match all identifiers that could be used to identify assets within the json, and from there I can specify a schema that I want asset descriptions to match. If you post this as an answer, I'll accept it. Thanks!