bundesAPI / bundesAPI/bundestag-api

OpenAPI Check Warnings

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Python
Stars
16
Forks
2
PR merge metrics
No merged PRs in 30d

Description

There are a few warnings during the OpenAPI Check see here:
https://github.com/bundesAPI/bundestag-api/pull/2/checks?check_run_id=8805966990

You can also run the check locally for example like this:
`docker run --rm -it -v $(pwd):/tmp stoplight/spectral lint --ruleset "/tmp/.spectral.yaml" "/tmp/openapi.yaml"`
And you should get this output:

```
2:6 warning info-contact Info object must have "contact" object. info
8:10 warning oas3-server-trailing-slash Server URL must not have trailing slash. servers[0].url
12:9 warning operation-description Operation "description" must be present and non-empty string. paths./blueprint/servlet/content/{ARTICLE_ID}/asAppV2NewsarticleXml.get
12:9 warning operation-operationId Operation must have "operationId". paths./blueprint/servlet/content/{ARTICLE_ID}/asAppV2NewsarticleXml.get
12:9 warning operation-tags Operation must have non-empty "tags" array. paths./blueprint/servlet/content/{ARTICLE_ID}/asAppV2NewsarticleXml.get
31:9 warning operation-description Operation "description" must be present and non-empty string. paths./static/appdata/plenum/v2/speaker.xml.get
31:9 warning operation-operationId Operation must have "operationId". paths./static/appdata/plenum/v2/speaker.xml.get
31:9 warning operation-tags Operation must have non-empty "tags" array. paths./static/appdata/plenum/v2/speaker.xml.get
42:9 warning operation-description Operation "description" must be present and non-empty string. paths./static/appdata/plenum/v2/conferences.xml.get
42:9 warning operation-operationId Operation must have "operationId". paths./static/appdata/plenum/v2/conferences.xml.get
42:9 warning operation-tags Operation must have non-empty "tags" array. paths./static/appdata/plenum/v2/conferences.xml.get
53:9 warning operation-description Operation "description" must be present and non-empty string. paths./xml/v2/ausschuesse/index.xml.get
53:9 warning operation-operationId Operation must have "operationId". paths./xml/v2/ausschuesse/index.xml.get
53:9 warning operation-tags Operation must have non-empty "tags" array. paths./xml/v2/ausschuesse/index.xml.get
64:9 warning operation-description Operation "description" must be present and non-empty string. paths./xml/v2/ausschuesse/{AUSSCHUSS_ID}.xml.get
64:9 warning operation-operationId Operation must have "operationId". paths./xml/v2/ausschuesse/{AUSSCHUSS_ID}.xml.get
64:9 warning operation-tags Operation must have non-empty "tags" array. paths./xml/v2/ausschuesse/{AUSSCHUSS_ID}.xml.get
84:9 warning operation-description Operation "description" must be present and non-empty string. paths./xml/v2/mdb/index.xml.get
84:9 warning operation-operationId Operation must have "operationId". paths./xml/v2/mdb/index.xml.get
84:9 warning operation-tags Operation must have non-empty "tags" array. paths./xml/v2/mdb/index.xml.get
95:9 warning operation-description Operation "description" must be present and non-empty string. paths./xml/v2/mdb/biografien/{MDB_ID}.xml.get
95:9 warning operation-operationId Operation must have "operationId". paths./xml/v2/mdb/biografien/{MDB_ID}.xml.get
95:9 warning operation-tags Operation must have non-empty "tags" array. paths./xml/v2/mdb/biografien/{MDB_ID}.xml.get
115:9 warning operation-description Operation "description" must be present and non-empty string. paths./iptv/player/macros/_x_s-144277506/bttv/mobile/feed_vod.xml.get
115:9 warning operation-operationId Operation must have "operationId". paths./iptv/player/macros/_x_s-144277506/bttv/mobile/feed_vod.xml.get
115:9 warning operation-tags Operation must have non-empty "tags" array. paths./iptv/player/macros/_x_s-144277506/bttv/mobile/feed_vod.xml.get
137:14 warning oas3-unused-component Potentially unused component has been detected. components.schemas.Result

```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.