Question: How to get a fully inlined JSON Schema using referencing package?

[KONRADS098]

Hi there, I'm trying to create a fully inlined JSON Schema where all references are resolved and included in a single document.

Example Schema

example-schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://example.com/schemas/example-schema",
    "type": "object",
    "properties": {
        "user": {
            "$ref": "https://example.com/schemas/user-schema"
        }
    }
}

Let's take this schema as an example

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://example.com/schemas/user-schema",
    "type": "object",
    "properties": {
        "profile": {
            "$ref": "https://example.com/schemas/profile"
        }
    }
}

This subschema is referenced by example-schema.json, and can have N* subschemas itself.

What I'm Trying to Achieve

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/schemas/example-schema",
    "type": "object",
    "properties": {
        "user": {
            "$ref": "#/$defs/user"
        }
    },
    "$defs": {
        "user": {
            "type": "object",
            "properties": {
                "profile": {
                    "$ref": "#/$defs/profile"
                }
            },
            "required": ["profile"]
        },
        "profile": {
            "type": "object",
            "properties": {
                "address": {
                    "$ref": "#/$defs/address"
                }
            },
            "required": ["address"]
        },
        "address": {
            "type": "object",
            "properties": {
                "street": { "type": "string" },
                "city": { "type": "string" }
            },
            "required": ["street", "city"]
        },
       # N* subschemas
    }
}

• All external schema references should be collected and placed in the appropriate definitions section (definitions or $defs based on draft version)
• References should be updated to point to the definitions section
• The process should work for N-level deep schemas
• The schema's draft version should be preserved
• The solution should be draft-agnostic, automatically using the correct keyword based on the schema's draft version

Questions

• Is there a built-in way to achieve this using the referencing package that I'm missing?
• If not, would this functionality be useful to add to the package?

I've looked through the documentation but might have missed something obvious. Any help would be appreciated!

[Julian]

Thanks for the issue -- this is #27 (so going to close it as a dupe of that).

It's definitely something that makes sense in the package (though note that IIRC it's not fully defined really for Draft 7, just for newer drafts, but it's likely that we could still bundle resources for Draft 7 in some not-fully-standardized way).

I'm unfortunately not sponsored to work full-time on the JSON Schema ecosystem anymore so I have significantly less bandwidth to get to this sort of thing. I definitely would appreciate and review an attempted contribution to work on this though.

(I.e. tl;dr yes this is desired, it will happen some day, though it's somewhat waiting on more funding/sponsorship to make that day sooner rather than later at the moment, or otherwise for contributors).