In de spectral config staat nu extends: spectral:oas. Dit betekent dat al deze rules worden toegevoegd aan de linter: https://meta.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules. Hierin staan naast validatie van OAS zelf ook spectral best practices, zoals dat er een warning komt als tags niet op alfabetische volgorde staan, terwijl dat geen API Design Rule is.
In het cli commando dat in de docs staat wordt severity niet meegegeven, waardoor hij default lint op error resultaten. In de OAS checker geven we echter ook warnings terug; zijn deze dan wel terecht? Of willen we alleen de severity: error rules overnemen? Zie hieronder:
- oas3-schema
- operation-operationId-unique
- path-params
- openapi-tags-uniqueness
- oas3-valid-media-example
- oas3-valid-schema-example
- oas3-server-variables
En wilen we deze dan los teruggeven of samenvoegen tot 1 ADR error (publish-openapi ) die zegt dat er een valide OAS moet zijn? Mijn voorkeur zou zijn om ze los terug te geven, en enkel publish-openapi te noemen in de berekening van de ADR score.
In de spectral config staat nu
extends: spectral:oas. Dit betekent dat al deze rules worden toegevoegd aan de linter: https://meta.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules. Hierin staan naast validatie van OAS zelf ook spectral best practices, zoals dat er een warning komt als tags niet op alfabetische volgorde staan, terwijl dat geen API Design Rule is.In het
clicommando dat in de docs staat wordt severity niet meegegeven, waardoor hij default lint operrorresultaten. In de OAS checker geven we echter ook warnings terug; zijn deze dan wel terecht? Of willen we alleen deseverity: errorrules overnemen? Zie hieronder:En wilen we deze dan los teruggeven of samenvoegen tot 1 ADR error (
publish-openapi) die zegt dat er een valide OAS moet zijn? Mijn voorkeur zou zijn om ze los terug te geven, en enkelpublish-openapite noemen in de berekening van de ADR score.