OpenBankProject / OpenBankProject/OBP-API
Path Parameters
Open
Nobody has claimed this yet.
question
tesobe
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 482
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 15
Description
Path parameters are variable parts of a URL path. They are typically used to point to a specific resource within a collection, such as a user identified by ID.
For instance: /users/{userId}
OBP-API uses next notation: /users/USER_ID
We need to consider using curly braces i.e {userId} instead of USER_ID in documentation.
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
Search the API documentation for path parameters written as USER_ID and compare them with the issue's /users/{userId} example. Update the relevant documentation to use curly-brace parameter names consistently, then verify the affected examples are correct.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100