Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve consistency on the web-api across all shareable resources #7011

Open
pcrespov opened this issue Jan 7, 2025 · 2 comments
Open

Improve consistency on the web-api across all shareable resources #7011

pcrespov opened this issue Jan 7, 2025 · 2 comments
Assignees
Labels
a:api framework api, data schemas, a:webserver issue related to the webserver service idea Proposed new functionality that is still not implemented t:enhancement Improvement or request on an existing feature

Comments

@pcrespov
Copy link
Member

pcrespov commented Jan 7, 2025

ReDoc

The web-api exposes some shareable resources, namely project, tag, wallet, workspace, service. We need ensure consistency on the sharing interface across all of them:

  1. share operations: should be shared using the same approach
    • GET /tags/{tag_id}/groups returns list fo
    • POST /tags/{tag_id}/groups/{group_id} with access_rights: to share tag_id with group_id with given access_rights
    • PATCH /tags/{tag_id}/groups/{group_id} with access_rights: to update access
    • DELETE /tags/{tag_id}/groups/{group_id} to unshare
  2. CRUD operations: resource schema must include myAccessRights
    • GET /tags/{tag_id} -> TagGet and TagGet.myAccessRights
  3. access layers:
    • role-based access
    • group-based access
    • constraints on special groups e.g. tag cannot be shared with everyone group or wallet can only be shared among users (i.e. primary groups)
    • invalid access rights e.g. read=False, write=True, delete=True
    • ...
  4. errors when operating resource
    • resource not found (404)
    • operation on resource forbidden (403) (i.e. caller has no access rights to perform an operation on this resource)
    • ...
@pcrespov pcrespov self-assigned this Jan 7, 2025
@pcrespov pcrespov added t:enhancement Improvement or request on an existing feature a:webserver issue related to the webserver service a:api framework api, data schemas, idea Proposed new functionality that is still not implemented labels Jan 7, 2025
@pcrespov pcrespov changed the title Improve consistency on resource sharing web-api Improve consistency on the web-api across all shareable resources Jan 7, 2025
@odeimaiz
Copy link
Member

odeimaiz commented Jan 7, 2025

support /workspaces:search?filters={trashed:true}

@odeimaiz
Copy link
Member

modified_at
modified_by

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:api framework api, data schemas, a:webserver issue related to the webserver service idea Proposed new functionality that is still not implemented t:enhancement Improvement or request on an existing feature
Projects
None yet
Development

No branches or pull requests

2 participants