Skip to content

Update rules when using POST for sensitive data#358

Merged
rartych merged 2 commits intocamaraproject:mainfrom
eric-murray:eric-murray-patch-1
Jan 8, 2025
Merged

Update rules when using POST for sensitive data#358
rartych merged 2 commits intocamaraproject:mainfrom
eric-murray:eric-murray-patch-1

Conversation

@eric-murray
Copy link
Collaborator

What type of PR is this?

  • enhancement/feature

What this PR does / why we need it:

The existing design guidelines allow the request body to be optional when using POST to transfer sensitive data. The changes mandate that the request body be present, even if no parameters need to be sent (e.g. if a 3-legged access token is used). In this case, and empty JSON object must be sent.

This change ensures that all APIs passing sensitive data using POST adopt a common design pattern.

Which issue(s) this PR fixes:

Fixes #247

Does this PR introduce a breaking change?

  • Yes
  • No

APIs with an optional POST request body must now make it mandatory, even if no parameters need to be sent

Note: I'm not aware of any current APIs that will be impacted by this change. Device Identifier has a PR which will make the request body mandatory.

Special notes for reviewers:

None

Changelog input

 release-note
 - Update rules when using POST for sensitive data making request body mandatory

Additional documentation

None

Copy link
Contributor

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@rartych rartych left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

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

LGTM

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.

Request body is required but all properties are optional

4 participants