fix: Adding a key for technical/private data in SFEOS #518
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
YuriZmytrakov
force-pushed
the
CAT-1522
branch
4 times, most recently
from
4b6e7e0 to
379ea80
Compare
jonhealy1
requested changes
Nov 5, 2025
Collaborator
jonhealy1
left a comment
jonhealy1
left a comment
There was a problem hiding this comment.
This is really useful, just a couple of thoughts:
- let's allow for a list of private data fields.
- most Users will have private fields listed under
propertiesso we need to account for nested fields
ie. PRIVATE_DATA_FIELDS=properties.private_id,properties.private_name
| private_data_field = os.getenv("PRIVATE_DATA_FIELD") | ||
| if get_bool_env("HIDE_PRIVATE_DATA") and private_data_field: | ||
| stac_item.pop(private_data_field, None) | ||
| return stac_item |
Collaborator
There was a problem hiding this comment.
- let's allow for a list of private data fields.
PRIVATE_DATA_FIELDS - most Users will have private fields listed under
propertiesso we need to account for nested fields
YuriZmytrakov
force-pushed
the
CAT-1522
branch
6 times, most recently
from
83990d9 to
1eaf552
Compare
jonhealy1
requested changes
Nov 6, 2025
|
|
||
|
|
||
| @pytest.mark.asyncio | ||
| async def test_hide_private_data_from_item(app_client, txn_client, load_test_data): |
Collaborator
There was a problem hiding this comment.
Everything is looking really good. Let's just add a test case with a field like properties.confidential to make sure that nested fields are being excluded.
Collaborator
Author
There was a problem hiding this comment.
Thank you @jonhealy1 I have expanded the test with a test case properties.private_data.
YuriZmytrakov
force-pushed
the
CAT-1522
branch
from
6cf20d9 to
92f0ca3
Compare
Gomez324
previously approved these changes
Nov 13, 2025
YuriZmytrakov
dismissed stale reviews from Gomez324 and jonhealy1
via
29ce3df
jonhealy1
approved these changes
Nov 13, 2025
jonhealy1
added a commit
that referenced
this pull request
Nov 13, 2025
**Related Issue(s):** - None **Description:** ### Added - Environment variable `EXCLUDED_FROM_ITEMS` to exclude specific fields from items endpoint response. Supports comma-separated list of fully qualified field names (e.g., `properties.auth:schemes,properties.storage:schemes`) [#518](#518) **PR Checklist:** - [x] Code is formatted and linted (run `pre-commit run --all-files`) - [x] Tests pass (run `make test`) - [x] Documentation has been updated to reflect changes, if applicable - [x] Changes are added to the changelog
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
Add the
HIDE_PRIVATE_DATAandPRIVATE_DATA_FIELDenvironment variables to toggle inclusion of private or technical fields in SFEOS responses:true: hides private datafalse: returns full responseImproves control over sensitive data exposure while maintaining backward compatibility.
PR Checklist:
pre-commit run --all-files)make test)