Invalid URL error is cryptic

Aperta
#86 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
api

Direzione di ricerca

Start in openapi_spec_validator/validators.py around line 48, where validation handles a spec containing a file-based $ref. Trace how jsonschema.exceptions.RefResolutionError is surfaced. Done means users receive a separate, actionable exception explaining that the filename should use the file://myfile.yaml format.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

When I validate a spec containing a $ref pointing to a file then I get an error like

jsonschema.exceptions.RefResolutionError: unknown url type: '../shared.yaml'

At the jsonschema level this makes some sense but clearly there is something I can do about it as an opeanapi validator user. Therefore I argue we should catch and reraise a separate exception telling the user to pass in a filename in the format file://myfile.yaml

Where shouild such handling go? In this method?

https://github.com/p1c2u/openapi-spec-validator/blob/f13bd8c4e05f8c2ab1c54c6021897d8ad99f29f9/openapi_spec_validator/validators.py#L48

Lingua principale
Python
Stelle
409
Fork
73
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di python-openapi/openapi-spec-validator

Tutte le issue di python-openapi/openapi-spec-validator

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.