python-jsonschema / python-jsonschema/referencing

Consider providing `retrieve` functions with an enclosing specification

Offen
#65 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
53
Forks
27
Ø Merge
1 T. 8 Std.
Gemergte PRs (30 T.)
8

Beschreibung

Sometimes one wants to retrieve a resource but default to the specification of the document it is contained within.

In other words, to call Resource.from_contents(..., default_specification=enclosing_specification) from within a retrieval function.

This isn't completely trivial to implement however, because users can call .get_or_retrieve(uri) directly, meaning the argument would have to exist there too. Additionally, resources can be root resources of course, so enclosing_specification would anyways potentially be None for such cases.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die im Issue genannten Abruffunktionen und die Einstiegspunkte Resource.from_contents und get_or_retrieve(uri) zu lesen. Verfolge, wie eine einschließende Spezifikation durch direkte und verschachtelte Abrufe weitergegeben werden könnte, einschließlich Root-Ressourcen, bei denen sie None ist. Die Aufgabe ist abgeschlossen, wenn der Abruf standardmäßig die Spezifikation des enthaltenden Dokuments verwenden kann, ohne direkte Aufrufe oder Root-Ressourcen zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api, backend-api-design
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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