Create Table: permission_type

[Neecolaa]

Dependency

• Missing Permission Type #147

Overview

We need to create the permission_type table so that we can update a shared data store across hackforla.org, vrms, civictechjobs, and tables (onboarding) project.

Details

A table and a model are the same thing

Action Items

• identify and document table description (see spreadsheet under Resources)
  • if not, reach out to PD leads #176
  • Long Description: i.e., adminVrms, adminBrigade, adminProject, member
  • Sheet: PermissionType - Data

id	name	description
	adminGlobal	Can CRUD anything
	adminVrms	Can R anything and update permissions for users to the level of Admin Brigade
	adminBrigade	Can CRUD anything related to a user or project assigned to their brigade
	adminProject	Can Read and Update anything related to their assigned project
	memberProject	Can Read anything related to their project that is visible
	memberGeneral	Can express interest in a project's open role if they are the role

• compare and check off the data fields (below) against the ERD. Note any fields in the ERD that's missing from the list. (see Resources)

• compare the check off associated tables (below) against the ERD. Note any associated tables in the ERD that's missing from the list (see Resources)

  • permission table is a related table and is not yet created
    • Create Table: user permission #22 seems to require some further investigation
    • as mentioned in Missing Permission Type #147, there seems to be a need to further investigate & get clarity on how to implement permissions
  • permission_history table is a related table and is not yet created
    • Create Table: permission_history #37 will need to investigate further later

• create a single model in Django (defining schema)

• add seed data

• write a test for the relationships this model will have with other models (e.g., creating a user and assigning them a set of permissions on a project).

• write an API end point
  

• write API unit tests

  • To resume at Adding API Tests

• document the endpoint

Resources/Instructions

• See People Depot Resources wiki page for links
  • ERD
  • Table and Field Definitions
  • API Endpoint
• See the wiki page for instructions.

Description

Dictionary of permission types used in #22

Data Fields

1. Copied from spreadsheet and checked off according to ERD. (unchecked items indicate a mismatch between ERD and spreadsheet, which requires a review)

   • (PK) id - int - Record Id
   • name - varchar
   • description - varchar

2. In ERD only (having items here indicates a mismatch, which requires a review)

   • None

Associated Tables

1. Copied from spreadsheet and checked off according to ERD. (unchecked items indicate a mismatch between ERD and spreadsheet, which requires a review)

   • permission (one-to-many)
   • permission_history (one-to-many)

2. In ERD only (having items here indicates a mismatch, which requires a review)

   • None

[Neecolaa]

Currently, this table isn't storing what each permission allows, nor is that information being stored somewhere else. Do we want to store the CRUD information here? Could use booleans (can_create, can_read, can_update, can_delete), it would depend on how we want to set up permissions

[joey-ma]

Handling permissions definitely is complex and complicated. I'd love to investigate more on how everything relates to each other to get clarity. Might be hard with the new job, but I'll try to be at the meeting tomorrow a bit after 5pm.

[fyliu]

I'm unassigning @joey-ma in case anyone wants to work on this.

Be aware that Joey has done previous work on this in draft PR #158. Anyone working on this should try to preserve the work that's already done by checking out that branch and continuing from there rather than start from scratch.

[ExperimentsInHonesty]

@alexlaw528
Please provide update

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."

• remember to add links to the top of the issue if they are going to be needed again.

[alexlaw528]

@ExperimentsInHonesty

1. Progress - Still working on getting comfortable with Django.
2. Blockers - None at the moment.
3. Availability - Will have 4-6 hrs this weekend to work on this.
4. ETA - Hoping to complete by end of next weekend (9/24)

[alexlaw528]

@fyliu - can you review PR #201?

Some of the other requests in this issue will likely require updating to include custom permission. But that seems out of scope of this issue.

[fyliu]

Closing issue since the PR is merged.