enabling format-assertion via adding vocabulary to a new meta-schema (dialect?)

Offen
  • Stimmt etwas nicht?
#1,355 7 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 6 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
tooling

Rechercherichtung

Beginne damit, den im Issue verlinkten CSAF-Schema-Fall zu reproduzieren, einschließlich Resource(contents=schema, specification=jsonschema.DRAFT202012) und Draft202012Validator.FORMAT_CHECKER. Lies die referenzierte meta_json_schema.json und die Diskussion rund um pull request 962; abgeschlossen ist die Aufgabe, wenn die unterstützte öffentliche API und das erwartete Verhalten der Formatassertion für ein benutzerdefiniertes Dialekt klar festgelegt oder dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

What is the supported way to check a JSON file via a (local) schema that wants to enforce the format assertions?
It is already supported?

My example is what https://github.com/oasis-tcs/csaf/pull/962 is trying to do.

https://github.com/oasis-tcs/csaf/blob/78f4b61ba2ba05d375a452ef7938abde16949457/csaf_2.1/json_schema/csaf_json_schema.json#L2

sets a custom dialect:

  "$schema": "https://docs.oasis-open.org/csaf/csaf/v2.1/meta_json_schema.json",

which locally is
https://github.com/oasis-tcs/csaf/blob/78f4b61ba2ba05d375a452ef7938abde16949457/csaf_2.1/json_schema/meta_json_schema.json
and just aims for adding the necessary vocabulary to treat formats as assertion.

However as can be seen in https://github.com/oasis-tcs/csaf/pull/962#issuecomment-2841656817 and above, that is needs to explicitly set jsonschema.DRAFT202012 to just add the

resource = Resource(contents=schema, specification=jsonschema.DRAFT202012)

I haven't found a public API way to give the new dialect to the referencing.jsonschema._SPECIFICATIONS. (As we do not change the referencing behaviour, it may or not may be okay to use specification=jsonschema.DRAFT202012., it just feels not right as the meta schema is available.

The other concern is that adding the vocabularies does not seem to change assertion checking in the implementation, only adding format_checker=Draft202012Validator.FORMAT_CHECKER decides this. According to my (limited) understanding adding the vocabulary of format-assertion should enable the checks by default. Okay - Draft202012Validator is for the Draft 2020-12 where formation assertion is off by default, but can be enabled.

If it already works, then an example of how to create a new meta schema (dialect) that has format-assertion enable like it should be done in accordance with Draft 2020-12 would be very helpful.

Vorherrschende Sprache
Python
Sterne
5k
Forks
718
Ø Merge
5 T. 9 Std.
Gemergte PRs (30 T.)
5

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python-jsonschema/jsonschema

Alle Issues in python-jsonschema/jsonschema

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.