microsoftgraph / microsoftgraph/msgraph-metadata
Add validation rules for schema sync PRs
Open
Nobody has claimed this yet.
- Dominant language
- XSLT
- Stars
- 166
- Forks
- 55
- Avg merge
- 16h 12m
- Merged PRs (30d)
- 14
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by reviewing the schema sync PRs #161, #164, #166, and #170, then identify how their CSDL files are processed. Done means validation can detect breaking v1 type changes, check CSDL-to-OpenAPI conversion and parsing, and assess SDK generation for type integrity against an acceptable runtime cost.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- ci-cd, testing-qa
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100