feature request: Make "Permissions" API objects consistent
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi, typescript
- Domain
- api
Research direction
Start by comparing the Permissions objects in the API specification for Set Role Permission and Create Role, using the linked operations as entry points. Determine which field names should be canonical, then trace how the TypeScript typings and OpenAPI-generated output represent both schemas. Done means the API models use one consistent representation without redundant deserialization handling.
Written by the indexing model from the issue text.
Description
What do you want to see?
There are multiple places in the API spec where an object representing a role's permissions (allowed and denied) is expressed, but I've noticed an inconsistency: Sometimes the fields are allow and deny (example: Set Role Permission), and sometimes they are a and d (example: Create Role). Could this be fixed up and unified in one way or another? It would make some API wrappers' lives easier not needing to include special JSON deserialization logic to handle the same model with differing field names, or having to include redundant model code. 😄
- Dominant language
- TypeScript
- Stars
- 42
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
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.
More from stoatchat/javascript-client-api
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 35/100
stoatchat/javascript-client-api#34 · 1 comment ·
-
feature request: Make GET channels/{target}/messages use request body instead of query parameters Openenhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
stoatchat/javascript-client-api#28 · 1 comment ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
stoatchat/javascript-client-api#18 · 2 comments · 4 reactions ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
stoatchat/javascript-client-api#16 · 2 comments · 8 reactions ·
All issues in stoatchat/javascript-client-api
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
corsairdev/corsair#1764 ·