Utilize attributes from an external JSON schema, within the identical hierarchy as the initial schema

Question

Utilize attributes from an external JSON schema, within the identical hierarchy as the initial schema

In a separate file, I have a remote schema named "person.json".

{
    "id":"#person",
    "type":"object",
    "properties": {
        "name": {"type":"string"},
        "gender": {
            "type":"string",
            "enum":["m", "f"]
        },
        "age": {"type":"number"}
    },
    "additionalProperties": false
}

Now, my original schema is called "man.json".

{
    "id":"#man",
    "type":"object",
    "$ref":"person.json",
    "properties": {
        "beard":"boolean",
        "moustache":"boolean"
    },
    "required": ["name"],
    "additionalProperties": false
}

I am looking to integrate the properties like "name, gender" from person.json on the same level as properties like "beard, moustache" from man.json.

To demonstrate validation:

{
    name: 'John',
    gender: 'm',
    age: 29,
    beard: false,
    mustache: true
}

The goal is to validate the example above with all properties at the same level, without any nesting.

If this integration is possible, could you guide me on how to achieve it? Thank you very much.

Sincerely, João

javascript json jsonschema

Answer 1

Answer №1

To incorporate the allOf keyword into your schema, along with the use of $ref, you can do the following:

{
    "id": "/schemas/man.json",
    "allOf": [{"$ref": "person.json"}],
    ...
}

(Please note: this is specified in version 4 of JSON Schema. In version 3, it was referred to as extends.)

In simpler terms, this setup implies that every instance adhering to the Man schema must also adhere to the Person schema.

An important aspect to consider is your utilization of the additionalProperties attribute. Given that the person.json schema disallows additional properties, any instance containing a "beard" property would not be considered a valid Person. If you plan on extending the Person schema, it is recommended to remove the restriction on additional properties.

(It's worth noting that there is some disagreement within the JSON Schema community regarding this behavior, but this aligns with the current specifications.)

Answer 2

To incorporate the allOf keyword into your schema, along with the use of $ref, you can do the following:

{
    "id": "/schemas/man.json",
    "allOf": [{"$ref": "person.json"}],
    ...
}

(Please note: this is specified in version 4 of JSON Schema. In version 3, it was referred to as extends.)

In simpler terms, this setup implies that every instance adhering to the Man schema must also adhere to the Person schema.

An important aspect to consider is your utilization of the additionalProperties attribute. Given that the person.json schema disallows additional properties, any instance containing a "beard" property would not be considered a valid Person. If you plan on extending the Person schema, it is recommended to remove the restriction on additional properties.

(It's worth noting that there is some disagreement within the JSON Schema community regarding this behavior, but this aligns with the current specifications.)

Answer 3

Answer №2

It seems that a single piece of data cannot meet the requirements of two different schemas simultaneously. In order to address this, you may have to devise a third schema that merges the two and then validate the data against it.

let personSchema = JSON.parse(personData);
let manSchema = JSON.parse(manData);

for (let prop in personSchema.properties) {
    manSchema.properties[prop] = personSchema.properties[prop];
}

let combinedSchema = JSON.stringify(manSchema);

Answer 4

It seems that a single piece of data cannot meet the requirements of two different schemas simultaneously. In order to address this, you may have to devise a third schema that merges the two and then validate the data against it.

let personSchema = JSON.parse(personData);
let manSchema = JSON.parse(manData);

for (let prop in personSchema.properties) {
    manSchema.properties[prop] = personSchema.properties[prop];
}

let combinedSchema = JSON.stringify(manSchema);

Utilize attributes from an external JSON schema, within the identical hierarchy as the initial schema

Answer №1

Answer №2

Similar questions

What is the best way to remove the class "active" from only one of the <li> elements using jQuery?

Change a nested for-loop into an Observable that has been transformed using RxJS

The second function in Vue.js was unable to initialize the data field within data() due to a missing call for assistance

Print JSON value to console

Synchronizing multiple file changes simultaneously in Node.js

Encountered an issue when deploying a Gatsby JS site on Netlify due to a non-zero exit code returned by the build script

Turn off JavaScript in the HTML submitted by users

Expanding and collapsing multiple tables in Material-UI

Issue with JQuery Each function not waiting for the inner function to complete

Is setTimeout trustworthy in Node.js environment?

Dividing a select option

Troubles with implementing Gson in Android applications

Exploring the contrast between window and document within jQuery

Exporting JSON data from Blender for use in Three.js

Using tabs within a Dialog prevents the Dialog from adjusting its height automatically

Attempting to conceal the select input and footer components of the Calendar component within a React application

Utilize CSS styling on dynamically loaded HTML content

JavaScript - Error: The '}' token was unexpected

`Troubleshooting Firebase Cloud Functions and Cloud Firestore integration`

In mongoose, documents are able to update autonomously without any explicit request