bundesAPI / dip-bundestag-api

Bundestag: Dokumentations- und Informationssystem für Parlamentsmaterialien
https://dip.bundestag.api.bund.dev/
16 stars 2 forks source link

Remove warnings from openapi.yaml #1

Closed wirthual closed 2 years ago

wirthual commented 2 years ago

This is the output of the current linting: https://github.com/bundesAPI/dip-bundestag-api/runs/5505716427

Most of the warnings are pretty clear on how to fix them.

For local testing install spectral: https://stoplight.io/open-source/spectral/

Then create a .spectral.yaml like this: set -C; echo "extends: spectral:oas" > .spectral.yaml

Then you should be able to lint it locally and remove the warnings one by one.