Define DB schema and APIs for UserRoles

🚀 Feature

Define the DB schema and APIs for user roles and permissions

NOTE : The delete user API should also call the remove user roles API

Implementation details

DB schema

---

MySQL

CREATE TABLE IF NOT EXISTS roles (
  role VARCHAR(255) NOT NULL,
  PRIMARY KEY (role)  
);

CREATE TABLE IF NOT EXISTS role_permissions (
  role VARCHAR(255) NOT NULL,
  permission VARCHAR(255) NOT NULL,
  PRIMARY KEY (role, permission),
  FOREIGN KEY (role) REFERENCES roles(role) ON DELETE CASCADE
);

CREATE INDEX role_permissions_permission_index ON role_permissions(permission);

CREATE TABLE IF NOT EXISTS user_roles (
  user_id VARCHAR(128) NOT NULL,
  role VARCHAR(255) NOT NULL,
  PRIMARY KEY (user_id, role),
  FOREIGN KEY (role)  REFERENCES roles (role) ON DELETE CASCADE
);

CREATE INDEX user_roles_role_index ON user_roles(role);

PSQL

CREATE TABLE IF NOT EXISTS roles (
  role VARCHAR(255) NOT NULL,
  CONSTRAINT roles_pkey PRIMARY KEY (role)  
);

CREATE TABLE IF NOT EXISTS role_permissions (
  role VARCHAR(255) NOT NULL,
  permission VARCHAR(255) NOT NULL,
  CONSTRAINT role_permissions_pkey PRIMARY KEY (role, permission),
  CONSTRAINT role_permissions_role_fkey FOREIGN KEY (role) REFERENCES roles(role) ON DELETE CASCADE
);

CREATE INDEX role_permissions_permission_index ON role_permissions(permission);

CREATE TABLE IF NOT EXISTS user_roles (
  user_id VARCHAR(128) NOT NULL,
  role VARCHAR(255) NOT NULL,
  CONSTRAINT user_roles_pkey PRIMARY KEY (user_id, role),
  CONSTRAINT user_roles_role_fkey FOREIGN KEY (role)  REFERENCES roles (role) ON DELETE CASCADE
);

CREATE INDEX user_roles_role_index ON user_roles(role);

---

Core API spec

---

Core APIs Psuedo code

---

• PUT /recipe/user/role: https://app.code2flow.com/oyBIcaFXIf5x
• POST /recipe/user/role/remove: https://app.code2flow.com/HUtwAGGHsJpL
• GET /recipe/user/roles: https://app.code2flow.com/jKKkoUebyxwN
• GET /recipe/role/users: https://app.code2flow.com/Y29CMz2T9ECw
• PUT /recipe/role: https://app.code2flow.com/MqlnBFW8t24n
• GET /recipe/role/permissions: https://app.code2flow.com/a326jJTajsE6
• POST /recipe/role/permissions/remove: https://app.code2flow.com/a08VVz5BZOyC
• GET /recipe/permission/roles: https://app.code2flow.com/vJMgpSsmpURB
• POST /recipe/role/remove: https://app.code2flow.com/PMRh9ehvJ9y9
• GET /recipe/roles: https://app.code2flow.com/HPxvxOUDqQT8

---

[rishabhpoddar]

Looks good.

[jscyo]

API Spec:

PUT /recipe/user/role:

• userId, role => { status: “OK”, didUserAlreadyHaveRole: boolean } | { status: “UNKNOWN_ROLE_ERROR” }

POST /recipe/user/role/remove:

• userId, role => {status: “OK”, didUserHaveRole: boolean } | {status: “UNKNOWN_ROLE_ERROR” }

GET /recipe/user/roles:

• userId => {status: “OK”, roles: str[ ] }

GET /recipe/role/users:

• role => {status: “OK”, users: str[ ] } | {status: “UNKNOWN_ROLE_ERROR” }

PUT /recipe/role:

• role, permissions?: str[ ] => { status: “OK”, createdNewRole: boolean }

GET /recipe/role/permissions

• role => { status: “OK”, permissions: str[ ]} | {status: “UNKNOWN_ROLE_ERROR” }

POST /recipe/role/permissions/remove:

• role, permissions?: str[ ] => { status: “OK”} | {status: “UNKNOWN_ROLE_ERROR” }

GET /recipe/permission/roles:

• permission => { status: “OK”, roles: str[]}

POST /recipe/role/remove

• role => { status: OK, didRoleExist: boolean }

GET /recipe/roles:

• => { status: “OK”, roles: str[ ] }