Gebruik enkel specifieke Spectral OAS rules#325
Conversation
Hiermee zorgen we ervoor dat we enkel regels aanzetten die ook relevant zijn voor de API Design Rules. Tevens zetten we die regels op error in plaats van warning, omdat ze ook verplicht zijn. Als laatste zorgt dit ervoor dat we ook netjes de publish OpenAPI design rule kunnen linken aan regels.
github-actions
Bot
added
Status: In bewerking
dvh
left a comment
dvh
left a comment
There was a problem hiding this comment.
Klopt het dat dit alleen voor draft is?
|
Wat bedoel je met draft? Deze PR staat niet in draft en is klaar om gereviewt te worden. |
|
@TimvdLippe ik bedoel in de werkversie van de ADR. Deze regels zouden toch ook toegevoegd kunnen worden aan 2.1? Want de publish openapi rule schrijft al voor dat het een valid OAS moet zijn. |
|
Klopt. Als we dit mergen, dan komt het in de werkversie en zou het mee gaan met ADR 2.3. Of we 2.1 en 2.2 gaan aanpassen zou ik nu niet kunnen zeggen. In principe passen we gepubliceerde documenten niet meer aan, behalve bij hoge uitzonderingen. Het zou mij verbazen als dit een dusdanige uitzondering is, dus ik ga er vanuit dat we 2.1 en 2.2 laten staan zoals het is. |
github-actions
Bot
added
Status: Ter goedkeuring
github-actions
Bot
added
Status: Klaar voor release
Hiermee zorgen we ervoor dat we enkel regels aanzetten die ook relevant zijn voor de API Design Rules. Tevens zetten we die regels op error in plaats van warning, omdat ze ook verplicht zijn. Als laatste zorgt dit ervoor dat we ook netjes de publish OpenAPI design rule kunnen linken aan regels.
|
We nemen deze PR ook mee in ADR 2.2. Dus enkel 2.1 zal deze wijziging niet hebben |
3 participants
Hiermee zorgen we ervoor dat we enkel regels aanzetten die ook relevant zijn voor de API Design Rules. Tevens zetten we die regels op error in plaats van warning, omdat ze ook verplicht zijn. Als laatste zorgt dit ervoor dat we ook netjes de publish OpenAPI design rule kunnen linken aan regels.
Fixes #315