Endpoint-level and field-level role/permission support
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 6
- Forks
- 3
- Avg merge
- 1h 54m
- Merged PRs (30d)
- 1
Description
At the company we work at, we have a need to expose APIs to different actors who have different roles and thus accesses. Essentially, some users have more or less access to the same API endpoints and on each endpoint, they may have access to some response fields or not.
However, at this point, there is no way to include this concept of role/permission support which we would at least want to use when generating documentation (and use one single OpenAPI definition file) - of course, it would mean that documentation support that new role/permission construct, but it starts with implementing it in the spec.
Is this something other folks are interested in?
Ideally, this issue should be assigned the Next.Proposal label.
Contributor guide
No contributing guide indexed for this repository
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
The issue does not name files, tests, or entry points. Start by locating the OpenAPI specification model and documentation generation path, then determine how endpoint- and field-level roles would be represented in one definition. Done requires an agreed proposal and corresponding specification and documentation support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, authorization, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100