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

[BUG] Various errors in rust_locker_open_api_spec.yml #6321

Open
2 tasks done
vil02 opened this issue Oct 15, 2024 · 4 comments · May be fixed by #6322
Open
2 tasks done

[BUG] Various errors in rust_locker_open_api_spec.yml #6321

vil02 opened this issue Oct 15, 2024 · 4 comments · May be fixed by #6322
Assignees
Labels
C-bug Category: Bug hacktoberfest Issues that are up for grabs for Hacktoberfest participants S-awaiting-triage Status: New issues that have not been assessed yet

Comments

@vil02
Copy link
Contributor

vil02 commented Oct 15, 2024

Bug Description

The two identical files api-reference/rust_locker_open_api_spec.yml and api-reference-v2/rust_locker_open_api_spec.yml contain some mistakes and errors.

Expected Behavior

The documentation should be clear.

Actual Behavior

The documentation contains some errors.

Steps To Reproduce

Not relevant.

Context For The Bug

Some examples:

This the the open API 3.0 specification for the card locker.

description: CRUD APIs to for working with data to be stored in the locker

description: CRUD APIs to for working with cards data to be stored in the locker (deprecated)

description: Provide the first key to unlock the locker

Environment

Not relevant.

Have you spent some time checking if this bug has been raised before?

  • I checked and didn't find a similar issue

Have you read the Contributing Guidelines?

Are you willing to submit a PR?

Yes, I am willing to submit a PR!

@vil02 vil02 added C-bug Category: Bug S-awaiting-triage Status: New issues that have not been assessed yet labels Oct 15, 2024
@vil02 vil02 linked a pull request Oct 15, 2024 that will close this issue
14 tasks
@gorakhnathy7 gorakhnathy7 added the hacktoberfest Issues that are up for grabs for Hacktoberfest participants label Oct 17, 2024
@Yashwanth-Chandrakumar
Copy link

/assign

@vil02
Copy link
Contributor Author

vil02 commented Oct 18, 2024

@Yashwanth-Chandrakumar: just to avoid any confusion, when I was creating this issue, I made a note that I am willing to submit a PR and the pull-request is already there: #6322.

@ravi-hash
Copy link

I would like to work on this. Can you assign it to me?

@vil02
Copy link
Contributor Author

vil02 commented Oct 20, 2024

@ravi-hash: please note that this is already done: #6322 waits for a review. Moreover, while creating this issue I selected "Yes, I am willing to submit a PR!".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: Bug hacktoberfest Issues that are up for grabs for Hacktoberfest participants S-awaiting-triage Status: New issues that have not been assessed yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants