Autogenerate JSON schema validations from CI Header classes
Summary
Currently, we need to manually update the JSON schema validations for spec
whenever we update the CI Header classes. This leads to extra work and occasional bugs when the schema does not get validated
Note: the next time we'll have to do this is when we update the Header classes for Steps
Proposal
Create a rake task to auto-generate the JSON schemas. This task can be manually run whenever the CI Header classes are updated (similar to updating the GraphQL docs)
Confirm purpose and User Reception (how does this benefit the user?)
Additional details
Some relevant technical details, if applicable, such as:
- Does this need a feature flag? No
- Does there need to be an associated instrumentation issue created related to this work? No
- Is there an example response showing the data structure that should be returned (new endpoints only)? N/A
- What permissions should be used?
- Is this EE or CE?
-
EE -
CE
-
- Additional comments:
Implementation Table
Group | Issue Link |
---|---|
backend |
|