microsoftgraph / microsoftgraph/msgraph-metadata
Add validation rules for schema sync PRs
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- XSLT
- Sterne
- 166
- Forks
- 55
- Ø Merge
- 16 Std. 12 Min.
- Gemergte PRs (30 T.)
- 14
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Der Issue nennt keine Dateien, Tests oder Einstiegspunkte. Beginne damit, die Schema-Sync-PRs #161, #164, #166 und #170 zu prüfen, und ermittle anschließend, wie deren CSDL-Dateien verarbeitet werden. Erledigt ist die Aufgabe, wenn die Validierung Breaking Changes an v1-Typen erkennen, die CSDL-to-OpenAPI-Konvertierung und das Parsing prüfen sowie die SDK-Generierung auf Typintegrität bei akzeptablen Laufzeitkosten bewerten kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- openapi
- Bereich
- ci-cd, testing-qa
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100