search

SchemaStore / schemastore

A collection of JSON schema files including full API
http://schemastore.org
Apache License 2.0
2.88k stars 1.56k forks source link

Allow providing an identifying JSON Path expression in addition to fileMatch? #3658

Open hoehrmann opened 1 month ago

hoehrmann commented 1 month ago

Description of the feature / enhancement.

With https://www.rfc-editor.org/rfc/rfc9535.html we now have a standardized query language. Some formats do not have established naming conventions or specific uses of them do not follow the convention for various reasons (like different instances of some configuration for different purposes or deployment stages), or there are name clashes and a code editor or validator might want to discriminate among multiple options, or you might want a hint for the specific schema if multiple versions exist. This could be gleaned from looking at the schema, but a pathMatch property or other extension of the current catalog format would be nice.

(I searched through open and closed issues, oddly could not find this suggestion.)

Are you making a PR for this?

No, someone else must create the PR.

hyperupcall commented 1 month ago

I definitely agree, this would be a very useful addition. Similar things have been proposed / discussed in #3460, #2440. Having some pathMatch property makes a lot of sense, but that also means that every single utility that reads from SchemaStore must also install some dependency for interpreting JSON Paths (i'm not sure the quality and number of implementations is the same as JSON Schema validators). I believe (very shallow) JSON Schemas can also be used.