hackforla / hackforla/peopledepot

Update Table: FAQ

Open
#557 0 comments 0 reactions 1 assignee Claimed by @bhamrickatmills View on GitHub
complexity: small feature: update table good first issue PII: FALSE role: back end s: hackforla.org s: kb s: org size: 0.25pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

We need to update the FAQ table model to add two new fields and change the name of another field.

#### Details
- The initial model issue: #51
- Discussion leading to this change is here: took place in meetings while consulting the [PD: Table and field explanations, current Field Permissions](https://docs.google.com/spreadsheets/d/1x_zZ8JLS2hO-zG0jUocOJmX16jh-DF5dccrd_OEGNZ0/edit?gid=749942651#gid=749942651)
- Changes are
- Add new field `permission_type`
- Add new field `project`
- Rename field from `tool_tip_name` to `title`

### Action Items

- Update existing Django model

- [ ] In the files indicated by Resource 1.01, Change the following items in the code

| Current Name in code | Updated Name | Updated Type (may already be this type) | FK Table | FK Table Issue(s) |
| -------------------- | ------------ | --------------------------------------- | -------- | ----------------- |
| tool_tip_name | title | varchar | | |

- [ ] Add the following items in the code

| Name | Type | FK Table | FK Table Issue(s) |
| ---- | ---- | -------- | ----------------- |
| permission_type | FK | permission_type | #24
| project | FK | project | #16

- Check to see if open issues in `FK status` below
- [x] If all Issues listed are closed (or there are no FKs), then skip the next 3 steps
- [ ] ~comment out the code after you create it (see FK Status below for open/closed state)~
- [ ] ~add an action item on the open issue to uncomment the code line you commented out when that issue's table is created.~
- [ ] ~Provide your file and line number as a permalink under resources in that issue~
- [ ] Write a test for the new relationships this model will have with other models (e.g., creating a user and assigning them a set of permissions on a project) if any.
- [ ] Update API end point
- [ ] Update API unit tests
- [ ] [generate a schema table definition](https://github.com/hackforla/peopledepot/issues/378#issuecomment-2493062821) and post it in a comment below and add a link to it in the Update Schema dependency issue.
- [ ] Document the endpoint in ReDocs

### FK status

- #24
- #16

### Resources
- 1.01 Code locations
- 1.01.01 [/app/core/models.py](https://github.com/hackforla/peopledepot/blob/main/app/core/models.py)
- 1.01.02 [/app/core/admin.py](https://github.com/hackforla/peopledepot/blob/main/app/core/admin.py)
- 1.01.03 [/app/core/api/serializers.py](https://github.com/hackforla/peopledepot/blob/main/app/core/api/serializers.py)
- 1.01.04
- 1.02 [People Depot Resources wiki page](https://github.com/hackforla/peopledepot/wiki/Resources-and-Links) for links
- ERD
- Table and Field Definitions
- API Endpoint
- 1.03 Spreadsheet: [PD: Table and field explanations, Current Field Permission tab](https://docs.google.com/spreadsheets/d/1x_zZ8JLS2hO-zG0jUocOJmX16jh-DF5dccrd_OEGNZ0/edit?gid=749942651)
- 1.03.01 [PD: Table and field explanations, tab: current Field Permissions, filter: FAQ](https://docs.google.com/spreadsheets/d/1x_zZ8JLS2hO-zG0jUocOJmX16jh-DF5dccrd_OEGNZ0/edit?gid=749942651#gid=749942651&fvid=752569951)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.