Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement use of linting rule set for Number Verification API #75

Closed
bigludo7 opened this issue Dec 12, 2023 · 3 comments · Fixed by #103
Closed

Implement use of linting rule set for Number Verification API #75

bigludo7 opened this issue Dec 12, 2023 · 3 comments · Fixed by #103
Assignees

Comments

@bigludo7
Copy link
Collaborator

Problem description
Implement use of linting rule set for Number Verification API.
what we have to do is well documented in Commonalities:
camaraproject/Commonalities#110
camaraproject/Commonalities#74

Expected action
Check our API with linting rule set
provide feedback to commonalities team

Additional context
cc: @rartych who asked project volunteer to perform this action.

@bigludo7 bigludo7 self-assigned this Dec 12, 2023
@DT-DawidWroblewski
Copy link
Collaborator

@rartych - please support

@rartych
Copy link
Contributor

rartych commented Apr 8, 2024

Offline linting gives the following results:

 167:12  warning  camara-properties-descriptions  Property description is missing or empty: "openId.description" property must be truthy     components.securitySchemes.openId
 210:15  warning  camara-properties-descriptions  Property description is missing or empty: "ErrorInfo.description" property must be truthy  components.schemas.ErrorInfo

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


number_verification.yaml
  7:1       error    trailing spaces  (trailing-spaces)
  20:1      error    trailing spaces  (trailing-spaces)
  21:24     error    trailing spaces  (trailing-spaces)
  31:1      error    trailing spaces  (trailing-spaces)
  33:1      error    trailing spaces  (trailing-spaces)
  120:11    error    wrong indentation: expected 12 but found 10  (indentation)
  164:11    error    wrong indentation: expected 12 but found 10  (indentation)

I propose to clean up the file and then follow the https://github.com/camaraproject/Commonalities/blob/main/documentation/API-linting-Implementation-Guideline.md to implement Github Action in the repository.

@bigludo7
Copy link
Collaborator Author

bigludo7 commented Apr 9, 2024

Hi @rartych
Thanks a lot.

I propose to clean up the file and then follow the https://github.com/camaraproject/Commonalities/blob/main/documentation/API-linting-Implementation-Guideline.md to implement Github Action in the repository.

That will be very helpful !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants