test-1

[Robin-West]

No description provided.

[github-actions]

❌ Spectral Linting FAILED

# Spectral OpenAPI Linting Results

## File: `./examples/bad-api.yml`



File:   /home/runner/work/SWS-API_Linting_Ruleset/SWS-API_Linting_Ruleset/exampl
es/bad-api.yml
1:1         ERROR        oas3-security-se  The API contract
                         ction-required    MUST include a
                                           'security'
                                           section at the
                                           root level

2:6         ERROR        info-contact      Info object must  info
                                           have "contact"
                                           object.

2:6         ERROR        info-description  Info              info
                                           "description"
                                           must be present
                                           and non-empty
                                           string.

2:6         ERROR        oas3-schema       "info" property   info
                                           must have
                                           required
                                           property
                                           "version".

2:6         ERROR        zebra-api-versio  API version must  info
                         n                 be specified in
                                           info.version

7:17        ERROR        path-should-not-  The word 'api'    paths./api/getUs
                         include-api       should not        ers
                                           appear in the
                                           path

7:17        WARNING      paths-kebab-case  Path should be    paths./api/getUs
                                           kebab-case        ers
                                           (lowercase with
                                           hyphens)

9:9         ERROR        operation-descri  Operation         paths./api/getUs
                         ption             "description"     ers.get
                                           must be present
                                           and non-empty
                                           string.

9:9         ERROR        operation-operat  Operation must    paths./api/getUs
                         ionId             have              ers.get
                                           "operationId".

9:9         WARNING      operation-tags    Operation must    paths./api/getUs
                                           have non-empty    ers.get
                                           "tags" array.

12:11       ERROR        oas3-schema       "0" property      paths./api/getUs
                                           must have         ers.get.paramete
                                           required          rs[0]
                                           property
                                           "required".

12:11       ERROR        path-params       Path parameter    paths./api/getUs
                                           "user_id" must    ers.get.paramete
                                           have "required"   rs[0]
                                           property that is
                                           set to "true".

12:11       ERROR        path-params       Parameter         paths./api/getUs
                                           "user_id" must    ers.get.paramete
                                           be used in path   rs[0]
                                           "/api/getUsers".

12:17       ERROR        path-parameters-  Path parameters   paths./api/getUs
                         camelCase-alphan  MUST follow       ers.get.paramete
                         umeric            camelCase         rs[0].name

16:19       ERROR        oas3-no-get-requ  GET requests      paths./api/getUs
                         est-body          MUST NOT have a   ers.get.requestB
                                           request body      ody

17:17       ERROR        oas3-request-sup  Requests MUST     paths./api/getUs
                         port-json         support           ers.get.requestB
                                           application/json  ody.content
                                           media type

22:15       ERROR        response-should-  Response for      paths./api/getUs
                         have-body         status code       ers.get.response
                                           '[200].content'   s[200]
                                           is missing a
                                           content section

22:15       WARNING      zebra-response-e  Responses should  paths./api/getUs
                         xamples           include examples  ers.get.response
                                                             s[200]

27:20       ERROR        no-file-extensio  Paths must not    paths./createUse
                         ns-in-paths       include file      r.json
                                           extensions

27:20       ERROR        path-should-have  Each path should  paths./createUse
                         -at-least-one-pl  contain at least  r.json
                         ural-noun         one plural noun
                                           segment

27:20       WARNING      paths-kebab-case  Path should be    paths./createUse
                                           kebab-case        r.json
                                           (lowercase with
                                           hyphens)

28:10       ERROR        operation-descri  Operation         paths./createUse
                         ption             "description"     r.json.post
                                           must be present
                                           and non-empty
                                           string.

28:10       ERROR        operation-operat  Operation must    paths./createUse
                         ionId             have              r.json.post
                                           "operationId".

28:10       WARNING      operation-tags    Operation must    paths./createUse
                                           have non-empty    r.json.post
                                           "tags" array.

32:15       WARNING      zebra-response-e  Responses should  paths./createUse
                         xamples           include examples  r.json.post.resp
                                                             onses[200]

35:24       ERROR        oas3-response-su  Success           paths./createUse
                         ccess-json        responses MUST    r.json.post.resp
                                           be                onses[200].conte
                                           application/json  nt.text/plain

40:15       ERROR        path-should-have  Each path should  paths./updateUse
                         -at-least-one-pl  contain at least  r
                         ural-noun         one plural noun
                                           segment

40:15       WARNING      paths-kebab-case  Path should be    paths./updateUse
                                           kebab-case        r
                                           (lowercase with
                                           hyphens)

41:9        ERROR        oas3-put-with-re  PUT requests      paths./updateUse
                         quest-body        MUST have a       r.put
                                           request body

41:9        ERROR        operation-descri  Operation         paths./updateUse
                         ption             "description"     r.put
                                           must be present
                                           and non-empty
                                           string.

41:9        ERROR        operation-operat  Operation must    paths./updateUse
                         ionId             have              r.put
                                           "operationId".

41:9        WARNING      operation-tags    Operation must    paths./updateUse
                                           have non-empty    r.put
                                           "tags" array.

44:9        ERROR        parser            Mapping key must  paths./updateUse
                                           be a string       r.put.responses[
                                           scalar rather     200]
                                           than number

44:13       ERROR        response-should-  Response for      paths./updateUse
                         have-body         status code       r.put.responses[
                                           '[200].content'   200]
                                           is missing a
                                           content section

44:13       WARNING      zebra-response-e  Responses should  paths./updateUse
                         xamples           include examples  r.put.responses[
                                                             200]

49:13       ERROR        path-should-have  Each path should  paths./api/user
                         -at-least-one-pl  contain at least
                         ural-noun         one plural noun
                                           segment

49:13       ERROR        path-should-not-  The word 'api'    paths./api/user
                         include-api       should not
                                           appear in the
                                           path

50:12       ERROR        operation-descri  Operation         paths./api/user.
                         ption             "description"     delete
                                           must be present
                                           and non-empty
                                           string.

50:12       ERROR        operation-operat  Operation must    paths./api/user.
                         ionId             have              delete
                                           "operationId".

50:12       WARNING      operation-tags    Operation must    paths./api/user.
                                           have non-empty    delete
                                           "tags" array.

52:15       WARNING      zebra-response-e  Responses should  paths./api/user.
                         xamples           include examples  delete.responses
                                                             [204]

61:5        WARNING      zebra-server-des  Each server must  servers[0]
                         cription          have a
                                           description

61:10       ERROR        oas3-protocol-ht  Servers MUST be   servers[0].url
                         tps-only          HTTPS and no
                                           other protocol
                                           is allowed.

69:12       ERROR        oas3-security-sc  The API contract  components
                         hemes-required    MUST include 'se
                                           curitySchemes'
                                           under components

71:10       WARNING      oas3-unused-comp  Potentially       components.schem
                         onent             unused component  as.User
                                           has been
                                           detected.

74:19       WARNING      zebra-schema-pro  Schema            components.schem
                         perties-descript  properties        as.User.properti
                         ion               should have       es.user_name
                                           descriptions

77:12       ERROR        properties-camel  JSON Schema       components.schem
                         Case-alphanumeri  properties MUST   as.User.properti
                         c                 follow camelCase  es.ID

77:12       WARNING      zebra-schema-pro  Schema            components.schem
                         perties-descript  properties        as.User.properti
                         ion               should have       es.ID
                                           descriptions

27 Unique Issue(s)
✖ 48 problems (33 errors, 15 warnings, 0 infos, 0 hints)


---

## File: `./examples/good-api.yml`



File:   /home/runner/work/SWS-API_Linting_Ruleset/SWS-API_Linting_Ruleset/exampl
es/good-api.yml
56:15       WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items.get.respo
                                                             nses[200]

74:15       WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items.get.respo
                                                             nses[400]

80:15       WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items.get.respo
                                                             nses[401]

99:15       WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items.post.resp
                                                             onses[201]

114:15      WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items.post.resp
                                                             onses[400]

138:15      WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items/{itemId}.
                                                             get.responses[20
                                                             0]

144:15      WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items/{itemId}.
                                                             get.responses[40
                                                             4]

171:15      WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items/{itemId}.
                                                             put.responses[20
                                                             0]

177:15      WARNING      zebra-response-e  Responses should  paths./inventory
                         xamples           include examples  -items/{itemId}.
                                                             put.responses[40
                                                             4]

1 Unique Issue(s)
✖ 9 problems (0 errors, 9 warnings, 0 infos, 0 hints)
✅ No issues found

---

🔗 View full detailed results in workflow artifacts