test(integration): Add a Bruno request for Get and Revoke API Key (GET /v1/wallets/:id/api-key) to the api-tests collection

Open Beginner friendly
#705 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
api, testing

Research direction

Read the existing api-tests/Whitelist/Get Config.bru request and inspect the route in crates/api/src/lib.rs. Add Bruno requests for GET and DELETE at /v1/wallets/{{wallet_id}}/api-key using the supplied environment variables, with status assertions. Update api-tests/README.md, then run the requests against a local server or with bru run.

Written by the indexing model from the issue text.

Description

area/integration area/testing enhancement good first issue help wanted

Description

The Bruno collection under api-tests/ has no request for GET /v1/wallets/{{wallet_id}}/api-key, although the route exists in crates/api/src/lib.rs.

Requirements and context

  • Where: api-tests/Wallets/, api-tests/README.md
  • Security: Use only test accounts and environment variables; no real tokens in the repo.
  • Testing: just fmt-check, just lint and just test must pass; add or update tests for the change.
  • Documentation: Update the nearest doc if behaviour changes; otherwise no doc change is needed.

Suggested execution

  • Comment on this issue to claim it, then fork the repository and branch from main.
  • Branch name: git checkout -b test/bruno-api-key-get-revoke

Implement changes

  • Add Get and Revoke API Key.bru under api-tests/Wallets/ following the style of api-tests/Whitelist/Get Config.bru. Add a second request for DELETE on the same path.
  • Use {{base_url}}, {{token}} and {{wallet_id}} variables; never hard-code credentials.
  • Add a short tests {} assertion for the expected status code and mention it in api-tests/README.md.

Test and commit

  • Run the request with Bruno against a local server (just run) or bru run and confirm it passes.
  • Run just fmt, just lint and just test locally before pushing (see CONTRIBUTING.md).
  • Commit with a conventional message and keep the change small and focused.

Example commit message

test(integration): add bruno request for api-key-get-revoke

Guidelines

  • Open the PR against main and link it with Closes #<this issue>.
  • Keep the diff focused on this issue; no unrelated refactors or formatting churn.
  • One line per comment, no bloated code; follow patterns already used in the crate.
  • Never commit secrets, .env files or real keys; use public test vectors only.
  • CI (fmt, clippy -D warnings, tests) must be green before requesting review.
  • Ask in the issue thread if anything is unclear before starting.
Dominant language
Rust
Stars
0
Forks
91
Avg merge
5h 23m
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Octo-Protocol-org/Octo-Protocol

All issues in Octo-Protocol-org/Octo-Protocol

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.