Create Table: permission_history

[Neecolaa]

Dependency

• [x] #22
• [ ] #181

Overview

We need to create the permission_history 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

• [x] identify and document table description (see spreadsheet under Resources)
  • [ ] if not, reach out to PD leads
• [x] 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)
• [x] 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)
• [ ] create a single model in Django (defining schema)
• [ ] 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
• [ ] 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

When a permission is overwritten in #22 a record of it will be stored in this table instead of being deleted.

All records that have dateEnded from the Permission table will be moved here 1:12 AM Pacific Time

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)

   • [x] (PK) id - int - Record Id
   • [x] (FK) user_id - int - Record Id
   • [x] (FK) project_id - int - Record Id
   • [x] (FK) permission_type_id - int
   • [x] (FK) practice_area_id - int - Record Id
   • [x] granted - timestamp
   • [x] ended - timestamp
   • [x] (FK) created_by - int - User ID of who first granted the permission
   • [x] (FK) updated_by - int - User ID of who last changed the permission

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)

   • [x] permission_type (many-to-one)
   • [x] practice_area (many-to-one)
   • [x] project (many-to-one)
   • [x] user (many-to-one)

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

   • None

[Neecolaa]

The permission table has the created_by and updated_by fields, but permission_history does not. They will be added to the ERD and the spreadsheet because both fields are useful when looking through the history:

created_by and updated_by are both foreign keys containing user ids. If a permission isn't what it should be, we can use these values to figure out who to ask.

• [x] added to ERD
• [x] added to spreadsheet

[Neecolaa]

ERD/SS To-do: replace role_id with practice_area_id

• [x] on the ERD
• [x] on the fields tab of the spreadsheet
• [x] on this issue

remove relationship between role and permission_history tables

• [x] on the ERD
• [x] on the spreadsheet
• [x] on this issue

add relationship between practice_area and permission_history tables

• [x] on the ERD
• [x] on the spreadsheet
• [x] on this issue

Discussion for these changes happened here: https://github.com/hackforla/peopledepot/discussions/170