camaraproject / OTPValidation

Repository to describe, develop, document and test the OTP Validation API family
https://wiki.camaraproject.org/display/CAM/OTPValidation
Apache License 2.0
6 stars 14 forks source link

Application of linting rules #52

Closed rartych closed 5 months ago

rartych commented 5 months ago

Problem description Running linting rule against current API specification gives the following results:

 152:18  warning  camara-properties-descriptions  Property description is missing or empty: "SendCodeBody.description" property must be truthy      components.schemas.SendCodeBody
 162:22  warning  camara-properties-descriptions  Property description is missing or empty: "SendCodeResponse.description" property must be truthy  components.schemas.SendCodeResponse
 169:22  warning  camara-properties-descriptions  Property description is missing or empty: "ValidateCodeBody.description" property must be truthy  components.schemas.ValidateCodeBody
 200:15  warning  camara-properties-descriptions  Property description is missing or empty: "ErrorInfo.description" property must be truthy         components.schemas.ErrorInfo
 217:16  warning  camara-properties-descriptions  Property description is missing or empty: "two_legged.description" property must be truthy        components.securitySchemes.two_legged

✖ 5 problems (0 errors, 5 warnings, 0 infos, 0 hints)

Results of yamllint: one-time-password-sms.yaml

  8:193     error    trailing spaces  (trailing-spaces)
  11:24     error    trailing spaces  (trailing-spaces)
  95:11     error    wrong indentation: expected 12 but found 10  (indentation)
  149:11    error    wrong indentation: expected 12 but found 10  (indentation)
  158:47    error    trailing spaces  (trailing-spaces)
  223:98    error    trailing spaces  (trailing-spaces)

Expected behavior Errors needs to be corrected and warnings reviewed if corrections are needed. After implementing corrections, the Github Action can be configured in the repository to check each PR.

Alternative solution

Additional context

bigludo7 commented 5 months ago

Thanks @rartych I will take a look to fix this.

bigludo7 commented 5 months ago

Hello @rartych - PR here https://github.com/camaraproject/OTPvalidationAPI/pull/53 for your consideration.