Merge pull request #317 from fecgov/release/sprint-44

Release/sprint 44
fecgov · Jul 11, 2024 · c9cb19f · c9cb19f
2 parents 61ef16e + b80088e
commit c9cb19f
Show file tree

Hide file tree

Showing 155 changed files with 3,007 additions and 3,343 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'Potential Bug: [Insert title here]'
+labels: bug
+assignees: WiseQA
+
+---
+
+**Where was the issue found:**
+- Committee ID:
+- Environment:
+- Browser:
+
+**Please describe the issue clearly and concisely**
+A clear and concise description of what the bug is.
+
+Approximate time the issue was found:
+
+**To Reproduce**
+How to replicate the issue:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md
diff --git a/README.md b/README.md
@@ -109,6 +109,24 @@ git push --set-upstream origin hotfix/my-fix
 ## Additional developer notes
 This section covers a few topics we think might help developers after setup.
 
+### Register changes to the validation JSON files in the fecfile-web-app and fecfile-web-api repositories
+After modified the JSON schema files, those changes must be registered in the [fecfile-web-app](https://github.com/fecgov/fecfile-web-app) and [fecfile-web-api](https://github.com/fecgov/fecfile-web-api) repositories using the hash of the commit of the edits.
+
+In the fecfile-web-app repo:
+1) Update the commit hash in the [package.json](https://github.com/fecgov/fecfile-web-app/blob/develop/front-end/package.json) file for the fecfile-validate dependency
+2) Remove the package-lock.json file
+3) Rebuild the package-lock.json file to commit it to the repo with the "npm install" command
+
+In the fecfile-web-api repo:
+1) Update the commit hash for the fecfile-validate dependency in the [requirements.txt](https://github.com/fecgov/fecfile-web-api/blob/develop/requirements.txt) file.
+
+### How to update the online documentation
+The online documentation for the validation JSON files is hosted on GitHub pages at https://fecgov.github.io/fecfile-validate/
+To update this documentation when changes are made to the JSON validation files, we use the [json-schema-for-humans](https://pypi.org/project/json-schema-for-humans/) python package. To generate the documentation, follow these steps:
+1) pip install -r requirements.txt
+2) cd schema
+3) ../bin/generate_schema_docs.sh
+
 ### Git Secrets
 Set up git secrets to protect oneself from committing sensitive information such as passwords to the repository.
 - First install AWS git-secret utility in your PATH so it can be run at the command line: https://github.com/awslabs/git-secrets#installing-git-secrets

diff --git a/bin/generate-spec-table.py b/bin/generate-spec-table.py
@@ -42,7 +42,7 @@
     "FIELD_FORM_ASSOCIATION",
 ]
 
-if "transaction_type_identifier" in data["properties"]:
+if not args.filename.startswith("Sch"):
     COLUMNS = COLUMNS[1:]
     FEC_PROPERTIES = FEC_PROPERTIES[1:]
 

diff --git a/docs/BUSINESS_LABOR_NON_CONTRIBUTION_ACCOUNT.html b/docs/BUSINESS_LABOR_NON_CONTRIBUTION_ACCOUNT.html
diff --git a/docs/C1_LOAN_AGREEMENT.html b/docs/C1_LOAN_AGREEMENT.html
diff --git a/docs/C2_LOAN_GUARANTOR.html b/docs/C2_LOAN_GUARANTOR.html
diff --git a/docs/CANDIDATE_CONTRIBUTIONS.html b/docs/CANDIDATE_CONTRIBUTIONS.html
diff --git a/docs/COM_IN_KIND_OUTS.html b/docs/COM_IN_KIND_OUTS.html
diff --git a/docs/COM_IN_KIND_RECEIPTS.html b/docs/COM_IN_KIND_RECEIPTS.html
diff --git a/docs/CONDUIT_EARMARKS.html b/docs/CONDUIT_EARMARKS.html
diff --git a/docs/CONDUIT_EARMARK_OUTS.html b/docs/CONDUIT_EARMARK_OUTS.html
diff --git a/docs/Contact_Candidate.html b/docs/Contact_Candidate.html
diff --git a/docs/Contact_Candidate_spec.html b/docs/Contact_Candidate_spec.html
@@ -1,5 +1,4 @@
 <!DOCTYPE html><html lang="en"><head><title>Contact_Candidate</title><link rel="stylesheet" href="spec_table.css"></head><body><table><caption>Specification for Contact_Candidate</caption><tr>
-<th>COL SEQ</th>
 <th>FIELD DESCRIPTION</th>
 <th>TYPE</th>
 <th>REQUIRED</th>
@@ -10,7 +9,6 @@
 <th>VALIDATION RULES</th>
 </tr>
 <tr>
-<td>1</td>
 <td>TYPE</td>
 <td>Dropdown</td>
 <td>X (error)</td>
@@ -21,7 +19,6 @@
 <td><ul><li>REQUIRED</li><li>must equal: CAN</li></td>
 </tr>
 <tr>
-<td>2</td>
 <td>CANDIDATE ID</td>
 <td>A/N-9</td>
 <td>X (error)</td>
@@ -32,7 +29,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 9</li><li>regex: ^P[0-9]{8}$|^[H|S][0-9]{1}[A-Z]{2}[0-9]{5}$</li></td>
 </tr>
 <tr>
-<td>3</td>
 <td>LAST NAME</td>
 <td>A/N-30</td>
 <td>X (error)</td>
@@ -43,7 +39,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 30</li><li>regex: ^[ -~]{0,30}$</li></td>
 </tr>
 <tr>
-<td>4</td>
 <td>FIRST NAME</td>
 <td>A/N-20</td>
 <td>X (error)</td>
@@ -54,7 +49,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 20</li><li>regex: ^[ -~]{0,20}$</li></td>
 </tr>
 <tr>
-<td>5</td>
 <td>MIDDLE NAME</td>
 <td>A/N-20</td>
 <td></td>
@@ -65,7 +59,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 20</li><li>regex: ^[ -~]{0,20}$</li></td>
 </tr>
 <tr>
-<td>6</td>
 <td>PREFIX</td>
 <td>A/N-10</td>
 <td></td>
@@ -76,7 +69,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 10</li><li>regex: ^[ -~]{0,10}$</li></td>
 </tr>
 <tr>
-<td>7</td>
 <td>SUFFIX</td>
 <td>A/N-10</td>
 <td></td>
@@ -87,7 +79,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 10</li><li>regex: ^[ -~]{0,10}$</li></td>
 </tr>
 <tr>
-<td>8</td>
 <td>STREET  1</td>
 <td>A/N-34</td>
 <td>X (error)</td>
@@ -98,7 +89,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 34</li><li>regex: ^[ -~]{0,34}$</li></td>
 </tr>
 <tr>
-<td>9</td>
 <td>STREET  2</td>
 <td>A/N-34</td>
 <td></td>
@@ -109,7 +99,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 34</li><li>regex: ^[ -~]{0,34}$</li></td>
 </tr>
 <tr>
-<td>10</td>
 <td>CITY</td>
 <td>A/N-30</td>
 <td>X (error)</td>
@@ -120,7 +109,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 30</li><li>regex: ^[ -~]{0,30}$</li></td>
 </tr>
 <tr>
-<td>11</td>
 <td>STATE</td>
 <td>A/N-2</td>
 <td>X (error)</td>
@@ -131,7 +119,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 2</li><li>max length: 2</li><li>regex: ^[A-Z]{2}$</li></td>
 </tr>
 <tr>
-<td>12</td>
 <td>ZIP</td>
 <td>A/N-9</td>
 <td>X (error)</td>
@@ -142,7 +129,6 @@
 <td><ul><li>REQUIRED if COUNTRY equals USA</li><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 9</li><li>regex: ^[ -~]{0,9}$</li></td>
 </tr>
 <tr>
-<td>13</td>
 <td>EMPLOYER</td>
 <td>A/N-38</td>
 <td></td>
@@ -153,7 +139,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 38</li><li>regex: ^[ -~]{0,38}$</li></td>
 </tr>
 <tr>
-<td>14</td>
 <td>OCCUPATION</td>
 <td>A/N-38</td>
 <td></td>
@@ -164,7 +149,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 38</li><li>regex: ^[ -~]{0,38}$</li></td>
 </tr>
 <tr>
-<td>15</td>
 <td>CANDIDATE OFFICE</td>
 <td>Dropdown</td>
 <td>X (error)</td>
@@ -177,7 +161,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>must be one of: ['H', 'S', 'P']</li></td>
 </tr>
 <tr>
-<td>16</td>
 <td>CANDIDATE STATE</td>
 <td>A/N-2</td>
 <td>X (error)</td>
@@ -188,7 +171,6 @@
 <td><ul><li>REQUIRED if CANDIDATE_OFFICE equals S</li><li>REQUIRED if CANDIDATE_OFFICE equals H</li><li>type: ['string', 'null']</li><li>min length: 2</li><li>max length: 2</li><li>regex: ^[A-Z]{2}$</li></td>
 </tr>
 <tr>
-<td>17</td>
 <td>CANDIDATE DISTRICT</td>
 <td>A/N-2</td>
 <td>X (error)</td>
@@ -199,7 +181,6 @@
 <td><ul><li>REQUIRED if CANDIDATE_OFFICE equals H</li><li>type: ['string', 'null']</li><li>min length: 2</li><li>max length: 2</li><li>regex: ^[0-9]{2}$</li></td>
 </tr>
 <tr>
-<td></td>
 <td>TELEPHONE</td>
 <td>N-10</td>
 <td></td>
@@ -210,7 +191,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 15</li><li>regex: ^\+\d{1,3} \d{10}$</li></td>
 </tr>
 <tr>
-<td></td>
 <td>COUNTRY</td>
 <td>Dropdown</td>
 <td>X (error)</td>

diff --git a/docs/Contact_Committee.html b/docs/Contact_Committee.html
diff --git a/docs/Contact_Committee_spec.html b/docs/Contact_Committee_spec.html
@@ -1,5 +1,4 @@
 <!DOCTYPE html><html lang="en"><head><title>Contact_Committee</title><link rel="stylesheet" href="spec_table.css"></head><body><table><caption>Specification for Contact_Committee</caption><tr>
-<th>COL SEQ</th>
 <th>FIELD DESCRIPTION</th>
 <th>TYPE</th>
 <th>REQUIRED</th>
@@ -10,7 +9,6 @@
 <th>VALIDATION RULES</th>
 </tr>
 <tr>
-<td>1</td>
 <td>TYPE</td>
 <td>Dropdown</td>
 <td>X (error)</td>
@@ -21,7 +19,6 @@
 <td><ul><li>REQUIRED</li><li>must equal: COM</li></td>
 </tr>
 <tr>
-<td>2</td>
 <td>COMMITTEE ID</td>
 <td>A/N-9</td>
 <td>X (error)</td>
@@ -32,7 +29,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 9</li><li>regex: ^C[0-9]{8}$</li></td>
 </tr>
 <tr>
-<td>3</td>
 <td>NAME</td>
 <td>A/N-200</td>
 <td>X (error)</td>
@@ -43,7 +39,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 200</li><li>regex: ^[ -~]{0,200}$</li></td>
 </tr>
 <tr>
-<td>4</td>
 <td>STREET  1</td>
 <td>A/N-34</td>
 <td>X (error)</td>
@@ -54,7 +49,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 34</li><li>regex: ^[ -~]{0,34}$</li></td>
 </tr>
 <tr>
-<td>5</td>
 <td>STREET  2</td>
 <td>A/N-34</td>
 <td></td>
@@ -65,7 +59,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 34</li><li>regex: ^[ -~]{0,34}$</li></td>
 </tr>
 <tr>
-<td>6</td>
 <td>CITY</td>
 <td>A/N-30</td>
 <td>X (error)</td>
@@ -76,7 +69,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 30</li><li>regex: ^[ -~]{0,30}$</li></td>
 </tr>
 <tr>
-<td>7</td>
 <td>STATE</td>
 <td>A/N-2</td>
 <td>X (error)</td>
@@ -87,7 +79,6 @@
 <td><ul><li>REQUIRED</li><li>type: string</li><li>min length: 1</li><li>max length: 2</li><li>regex: ^[ -~]{0,2}$</li></td>
 </tr>
 <tr>
-<td>8</td>
 <td>ZIP</td>
 <td>A/N-9</td>
 <td>X (error)</td>
@@ -98,7 +89,6 @@
 <td><ul><li>REQUIRED if COUNTRY equals USA</li><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 9</li><li>regex: ^[ -~]{0,9}$</li></td>
 </tr>
 <tr>
-<td>12</td>
 <td>TELEPHONE</td>
 <td>N-10</td>
 <td></td>
@@ -109,7 +99,6 @@
 <td><ul><li>type: ['string', 'null']</li><li>min length: 0</li><li>max length: 15</li><li>regex: ^\+\d{1,3} \d{10}$</li></td>
 </tr>
 <tr>
-<td></td>
 <td>COUNTRY</td>
 <td>Dropdown</td>
 <td>X (error)</td>

diff --git a/docs/Contact_Individual.html b/docs/Contact_Individual.html