chore/sps-context-header-allowed-chars #106
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
djbqrex
commented
Oct 7, 2025
|
A reminder as this change goes in we'll need to update the shared model for sps-execution-context: https://github.com/SPSCommerce/sps-api-design/blob/e6d6181cdafe0fee311c4bf1bf0ae75a6d8988f7/reusable-models/sps-api-standards/global.1.0.oas.yml#L244-L253 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sps-Execution-Context ASCII constraints
What changed:
This update:
A-Z,a-z,0-9, the underscore_, and hyphen-.Why this matters:
The header drives dataflow context across services and being a header, it is a user defined value that is a common surface for log injection risks. Narrowing the allowed character set, keeping default-to-prod behavior, and ensuring the header value is echoed in responses helps improve safety, testability, and consistency across the stack without broad API changes.
The changes stay documentation-only and are designed to minimize disruption while guiding developers and tools toward safer, predictable handling and propagation of the header.
Concerns:
Backwards compatibility is a concern and we need to ensure no use of the header in production today violates this new change. To do that we will advertise this change to relevant channels and gather feedback.