Repository navigation
Limit module settings returned by workload API - #7560
Open
Bilal Sellak (bilalsellak) wants to merge 2 commits into
Open
Bilal Sellak (bilalsellak) wants to merge 2 commits into
Bilal Sellak (bilalsellak) wants to merge 2 commits into
Conversation
The workload API module list now returns only the image and image hash in each module's settings. Other runtime settings, such as create options, are omitted. Full module settings remain available through the management API.
Bilal Sellak (bilalsellak)
force-pushed
the
fix/workload-module-list-settings
branch
from
October 12, 2026 18:46
df7680d to
3952d52
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The security boundary lacks handler-level regression coverage, and the API wording does not precisely describe the fixed allowlist.
4 open findings
What changed in this PR
Restricts workload module listings to safe image metadata while preserving management API behavior.
Changes:
- Allows only
imageandimageHashin workload responses. - Adds redaction unit coverage.
- Updates all workload API specifications.
| File | Description |
|---|---|
edgelet/edgelet-http-workload/src/module/list.rs |
Filters module settings and tests redaction. |
edgelet/api/workloadVersion_2020_07_07.yaml |
Updates response documentation. |
edgelet/api/workloadVersion_2019_01_30.yaml |
Updates response documentation. |
edgelet/api/workloadVersion_2018_06_28.yaml |
Updates response documentation. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Verify that GET /modules returns only image and imageHash for every module, and state the exact returned settings fields in the workload API specs.
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
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.
This change is to make he workload API
GET /modulesresponse now return onlyimageandimageHashin each module'ssettings. Other runtime-specific settings, such ascreateOptions, are omitted. Module names, types, and status are unchanged.Azure IoT Edge PR checklist:
This checklist is used to make sure that common guidelines for a pull request are followed.
General Guidelines and Best Practices
Testing Guidelines