microsoftgraph / microsoftgraph/msgraph-metadata

Add validation rules for schema sync PRs

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

Nessuno ha ancora preso questa issue.

Lingua principale
XSLT
Stelle
166
Fork
55
Merge medio
16h 12m
PR unite (30g)
14

Descrizione

We started getting schema sync PRs, e.g. #161 #164 #166 #170

We can run some of the schema validation rules on these CSDL files including:

  • whether there are any breaking changes, i.e. if any type rename or removal operation happens in v1 models
  • whether we are able to successfully convert them into OpenAPI docs
    • conversion and parsing can be simple checks here
  • whether we can generate SDKs which has a potential to reveal some of the type integrity issues in the schema
    • we should weigh how fast this is against how many potential issues we can find at the time of PR

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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.

Direzione di ricerca

L’issue non indica file, test o punti di ingresso. Inizia esaminando le PR di sincronizzazione dello schema #161, #164, #166 e #170, quindi identifica come vengono elaborati i relativi file CSDL. Il lavoro è completato quando la validazione può rilevare modifiche incompatibili ai tipi v1, verificare la conversione da CSDL a OpenAPI e il parsing, e valutare la generazione dell’SDK in termini di integrità dei tipi con un costo di esecuzione accettabile.

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

Valutazione

Stack tecnologico
openapi
Ambito
ci-cd, testing-qa
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.