Remove Hardcoded API key #134
Conversation
There was a problem hiding this comment.
Pull request overview
This PR addresses a critical security issue by removing a hardcoded API key for The Blue Alliance and making it configurable through yearly config files. Additionally, it updates year references from 2020 to 2025 in HTML files and fixes several documentation typos and formatting issues.
Key Changes:
- Removed hardcoded TBA API key from
TBAInterface.jsand added it as a configurable variable in all yearly config files - Updated year references from 2020 to 2025 in HTML page headers
- Fixed spelling error "Auto Aquire" → "Auto Acquire" in 2020 config file
- Improved documentation formatting and fixed typos in
Configuration.mdandREADME.md
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| resources/js/TBAInterface.js | Removed hardcoded API key and fixed typo in comment ("funcitons" → "functions") |
| pit.html | Updated year from 2020 to 2025 in page headers |
| index.html | Updated year from 2020 to 2025 in pre-match, auton, and teleop page headers |
| docs/Configuration.md | Improved markdown formatting with proper bullet points and spacing, removed trailing periods from section headers |
| archive/2024/crescendo_config.js | Added configurable authKey variable with instructional comment |
| archive/2023/CU_config.js | Added configurable authKey variable with instructional comment |
| archive/2023/CU_GS_config.js | Added configurable authKey variable with instructional comment |
| archive/2022/RR_config.js | Added configurable authKey variable with instructional comment |
| archive/2022/RR_GS_config.js | Added configurable authKey variable with instructional comment |
| archive/2020/IR_config.js | Added configurable authKey variable and fixed spelling error ("Aquire" → "Acquire") |
| README.md | Updated documentation to reference config files for API key, improved markdown formatting, changed [TOC] marker, updated year references, and corrected line number reference |
| 2025/reefscape_config.js | Added configurable authKey variable with instructional comment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 participant
What type of PR is this? (check all applicable)
Changes
Description
A few changes fixing security vulnerabilities for The Blue Alliance by removing the hard-coded API key, and adding a variable in the configuration to replace it. The docs were also updated to reflect this change and to fix some minor typos.