bcgov / bcgov/entity

Replace Direct(internal) API URLs with API Gateway URLs

Open
#32,927 18 comments 0 reactions 0 assignees View on GitHub
SRE
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

Description:
Our applications currently use direct (internal) API endpoint URLs from Google Cloud Run (e.g., *.run.app). Public users have reported access issues due to network restrictions and firewalls. To improve accessibility, maintainability, observability, and security, we should route all API traffic through API Gateway instead of directly exposing Cloud Run URLs.

Acceptance Criteria:

- [ ] Identify all direct Cloud Run API URLs in use.

- [ ] Generate API Gateway keys for each API in all environments (dev, test, sandbox, prod).

- [ ] Update relevant entries in 1Password with new API Gateway URLs and keys.

- [ ] Update frontend applications to use API Gateway URLs with API key.

- [ ] Verify functionality of all frontend apps post-update.

Impact:
Using API Gateway enables improved API management through better traffic monitoring, rate limiting, centralized logging, and enhanced security.

List of APIs that using in frontend applications:
- [x] Auth
- [x] Pay ~(not enable yet)~
- [x] Business ~(not enable yet)~
- [x] Business AR
- [x] Namex
- [x] PPR
- [x] MHR
- [x] Search (has both API Gateway URL and Direct URL)
- [x] BOR (has both API Gateway URL and Direct URL)
- [x] STRR

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the direct Cloud Run URLs used by the frontend applications, using the listed APIs as the scope. Review the API Gateway URL and key requirements for dev, test, sandbox, and prod, then update the corresponding 1Password entries and frontend configuration. Done means all listed frontend apps use API Gateway URLs with keys and their functionality is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
google-cloud, javascript
Domain
api, cloud, frontend, security
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.