Confirm x-id and x-role belong inside info.contact against the SmartAPI validator

Aperta
#301 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python, yaml
Ambito
api

Direzione di ricerca

Start with openapi.yml and CLAUDE.md, then check how the SmartAPI validator handles info.contact.x-id and x-role and whether the registry reads them. Compare the result with NodeNorm’s served OpenAPI document. Done means the fields’ accepted location and registry behavior are confirmed, with the convention documented in CLAUDE.md or a comment in openapi.yml.

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

Descrizione

#294 nested the loose email / name / x-id / x-role keys of openapi.yml under info.contact,
matching what NodeNorm serves:

info:
  contact:
    email: [email protected]
    name: Chris Bizon
    x-id: https://github.com/cbizon
    x-role: responsible developer

x-id and x-role are not fields of the OpenAPI 3.0.2 Contact Object. They are presumably a
Translator convention carried as specification extensions — NodeNorm has served them this way for a
long time — but nobody has checked that against the SmartAPI validator, and #294 is the second time
this block has been wrong without anyone noticing.

Worth confirming rather than changing blind:

  • Does the SmartAPI validator accept x-id / x-role under contact, and does the registry
    actually read them?
  • If they are expected somewhere else (info.x-translator, say), move them and note the convention
    in CLAUDE.md.
  • If they are accepted but ignored, say so in a comment in openapi.yml so the next person doesn't
    re-litigate it.

Found while fixing #294; not a regression, and the current form is at least consistent with NodeNorm.

Lingua principale
Python
Stelle
5
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna 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 NCATSTranslator/NameResolution

Tutte le issue di NCATSTranslator/NameResolution

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.