OpenLiberty / OpenLiberty/docs
SEC-44: Document REST Endpoints
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 4m
- Merged PRs (30d)
- 35
Description
This issue came as a result of serviceability on The SEC-44 Reader role feature.
We should document our administrative REST endpoints and what roles are required to access each operation on those endpoints. I am not sure whether listing them all in one location is better or listing them by feature, so you know what endpoints are enabled when you start a feature. I tend to think the latter is better. It would be best if it is self-documenting but not sure how we can do that.
The end-goal should be that customers can easily determine what REST endpoints are active given a feature, and what roles are required to access those endpoints.
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 by reviewing the SEC-44 Reader role feature and inventorying the administrative REST endpoints associated with each feature. No files or tests are identified in the issue, so first locate the existing endpoint and role documentation. Done means customers can determine which endpoints a feature enables and which roles can access each operation.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, authorization, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100