$ref should accept $id references

[ImBoop]

As part of JSONSchema Draft 6, $ref can point to a definition defined with an $id (or just id, spec seems vague if its $id or id in v6) -- it would be wonderful if we could get support for that here.

For instance, in definitions we will be able to use {"references": { "$id": "#test", ... }} and in our core properties, refer to it via {"properties": {"$ref": "#test", ...}}

Thanks!

[forivall]

I'm interested in tackling this, either in a PR or in an external vscode extension (probably both, as i'll want to have the flexibility of my own extension for other resolver logic for external references, and then i'll upstream relevant features).

some links:

• json-schema.org Documentation
• draft 6 spec on $id

[aeschli]

Hi @forivall, thanks for the interest, you are very welcome, a PR would be great!

We currently resolve the $refs in a step called resolveSchemaContent:

vscode-json-languageservice/src/services/jsonSchemaService.ts

Line 392 in 65f660b

public resolveSchemaContent(schemaToResolve: UnresolvedSchema, schemaURL: string, dependencies: SchemaDependencies): Thenable<ResolvedSchema> {

To run and debug this, see here for instructions. You can find some ref related tests her.

I'm happy to help. I've started looking into it but realized it's not a trivial change and we might have to restructure the way we do the resolving.

[jviotti]

As a workaround, my JSON Schema CLI tool supports performing bundling without making use of identifiers to at least make schemas work with Visual Studio Code: https://github.com/Intelligence-AI/jsonschema/blob/main/docs/bundle.markdown.