camaraproject / DeviceStatus

Repository to describe, develop, document and test the Device Status API family
Apache License 2.0
11 stars 33 forks source link

Corrections needed to resolve linting errors #94

Closed rartych closed 5 months ago

rartych commented 7 months ago

Problem description Spectral linter applied to device-status.yaml and produces 53 errors (!). Most of them are like:

  140:9     error  parser                          Mapping key must be a string scalar rather than number
                                                                           paths./connectivity.post.responses[200]

The response codes (200,...) should be strings

This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML.

Other errors are caused by numeric values of event id in examples that should be quoted as stings:

  1008:13    error  oas3-valid-media-example        "id" property type must be string                                                                                                                      components.examples.ROAMING_STATUS.value.id

Expected behavior Corrections for indicated errors

Alternative solution

Additional context Linting rules are introduced in https://github.com/camaraproject/Commonalities/pull/74 https://github.com/camaraproject/Commonalities/pull/110