TechDebt - Postman

[NickPhura]

Overview

Links to Jira tickets

n/a

Description of relevant changes

• Remove postman collection (moved to S3)
• Update the postman readme
• Update the postman collection (now supports user tokens in addition to service client tokens)
  • Combined the SIMS and BioHub postman files.
• Added a new confluence page for postman: https://apps.nrs.gov.bc.ca/int/confluence/x/LwQtCQ
  • It is basically just a clone of the readme
• Minor update to the xlsx process endpoint (make survey_id a required request body value)
  • Just happened to be looking at the file, so adjusted it while I was there.

PR Checklist

A list of items that are good to consider when making any changes.

Note: this list is not exhaustive, and not all items are always applicable.

Code

• New files/classes/functions have appropriately descriptive names and comment blocks to describe their use/behaviour
• I have avoided duplicating code when possible, moving re-usable pieces into functions
• I have avoided hard-coding values where possible and moved any re-usable constants to a constants file
• My code is as flat as possible (avoids deeply nested if/else blocks, promise chains, etc)
• My code changes account for null/undefined values and handle errors appropriately
• My code uses types/interfaces to help describe values/parameters/etc, help ensure type safety, and improve readability

Style

• My code follows the established style conventions
• My code uses native material-ui components/icons/conventions when possible

Documentation

• I have commented my code sufficiently, such that an unfamiliar developer could understand my code
• I have added/updated README's and related documentation, as needed

Tests

• I have added/updated unit tests for any code I've added/updated
• I have added/updated the Postman requests/tests to account for any API endpoints I've added/updated

Linting/Formatting

• I have run the linter and fixed any issues, as needed
  See the lint commands in package.json
• I have run the formatter and fixed any issues, as needed
  See the format commands in package.json

SonarCloud

• I have addressed all SonarCloud Bugs, Vulnerabilities, Security Hotspots, and Code Smells

[github-actions]

Openshift URLs for the PR Deployment:

• App Route: https://biohubbc-app-961-af2668-dev.apps.silver.devops.gov.bc.ca/
• Api Route: https://biohubbc-api-961-af2668-dev.apps.silver.devops.gov.bc.ca/
• Pods: https://console.apps.silver.devops.gov.bc.ca/k8s/ns/af2668-dev/pods?name=961

[codecov]

Codecov Report

Merging #961 (62f9684) into dev (63878ab) will decrease coverage by 14.18%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##              dev     #961       +/-   ##
===========================================
- Coverage   80.20%   66.03%   -14.18%     
===========================================
  Files         176      352      +176     
  Lines        6896    11437     +4541     
  Branches     1231     1979      +748     
===========================================
+ Hits         5531     7552     +2021     
- Misses       1094     3482     +2388     
- Partials      271      403      +132     

Impacted Files	Coverage Δ
api/src/paths/xlsx/process.ts	96.55% <ø> (-0.33%)	⬇️
app/src/components/fields/AutocompleteField.tsx	80.00% <0.00%> (ø)
app/src/hooks/api/useAxios.ts	78.57% <0.00%> (ø)
...eatures/surveys/components/ProprietaryDataForm.tsx	76.92% <0.00%> (ø)
.../src/components/attachments/FileUploadWithMeta.tsx	9.09% <0.00%> (ø)
...p/src/components/fields/MultiAutocompleteField.tsx	36.84% <0.00%> (ø)
app/src/features/projects/view/ProjectHeader.tsx	4.16% <0.00%> (ø)
...es/projects/view/components/IUCNClassification.tsx	100.00% <0.00%> (ø)
...rc/components/boundary/InferredLocationDetails.tsx	20.00% <0.00%> (ø)
app/src/pages/403/AccessDenied.tsx	76.92% <0.00%> (ø)
... and 167 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[KjartanE]

⚡

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication