oxidecomputer / oxidecomputer/omicron
BGP API: Rename `name_or_id` path param
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
It would make sense to call it announce_set. bgp_announce_set is probably unnecessary.
Name or ID path params should be named with the kind of resource they are so that in the CLI or other clients, it's clear what it is the name or ID of. Example:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in nexus/external-api/src/lib.rs around lines 1573-1595 and compare the resource-specific path parameter naming shown around lines 618-627. Rename the BGP API path parameter to announce_set as described, remove the unnecessary bgp_announce_set naming if present, and verify the resulting API and client-facing parameter names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100