Skip to content

Comments

feat: censor sensitive fields in API responses#58

Merged
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/censor-sensitive-fields
Jun 17, 2025
Merged

feat: censor sensitive fields in API responses#58
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/censor-sensitive-fields

Conversation

@jason-lynch
Copy link
Member

With this change, the following sensitive fields will be omitted from all API responses:

  • Database user passwords
  • Backup and restore repository credentials:
    • S3 keys/secrets
    • Azure keys
    • GCS keys

We want to enable users to manage databases without storing the original create request. So, this commit also changes the update behavior so that these sensitive fields can be omitted from update requests. This makes it safe to store the database spec in version control.

Users can modify the credentials, such as when rotating passwords, by including the updated values in an update request.

PLAT-86

@jason-lynch jason-lynch force-pushed the feat/PLAT-86/human-readable-ids branch from 87f64ba to 1293ea0 Compare June 16, 2025 11:30
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/censor-sensitive-fields branch 2 times, most recently from eac3065 to b648c46 Compare June 16, 2025 11:39
@jason-lynch jason-lynch requested review from mmols and tsivaprasad June 16, 2025 11:41
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/human-readable-ids branch from 1293ea0 to 8511659 Compare June 16, 2025 17:42
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/censor-sensitive-fields branch from b648c46 to 0f916d1 Compare June 16, 2025 17:43
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/human-readable-ids branch from 8511659 to ed23079 Compare June 16, 2025 19:12
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/censor-sensitive-fields branch from 0f916d1 to d73f271 Compare June 16, 2025 19:12
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/human-readable-ids branch from ed23079 to 8647b1a Compare June 17, 2025 11:48
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/censor-sensitive-fields branch from d73f271 to 04ace88 Compare June 17, 2025 11:49
Base automatically changed from feat/PLAT-86/human-readable-ids to main June 17, 2025 12:07
With this change, the following sensitive fields will be omitted from
all API responses:

- Database user passwords
- Backup and restore repository credentials:
  - S3 keys/secrets
  - Azure keys
  - GCS keys

We want to enable users to manage databases without storing the original
create request. So, this commit also changes the update behavior so that
these sensitive fields can be omitted from update requests. This makes
it safe to store the database spec in version control.

Users can modify the credentials, such as when rotating passwords, by
including the updated values in an update request.

PLAT-86
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/censor-sensitive-fields branch from 04ace88 to 5d5c2b2 Compare June 17, 2025 17:56
Copy link
Contributor

@tsivaprasad tsivaprasad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jason-lynch jason-lynch merged commit 57bf323 into main Jun 17, 2025
2 checks passed
@jason-lynch jason-lynch deleted the feat/PLAT-86/censor-sensitive-fields branch June 17, 2025 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants