refactor(set): validate blocklist instead of allowlist #151
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
aviatco
reviewed
Jan 29, 2026
| query = args.query | ||
|
|
||
| utils_set.validate_expression(query, JMESPATH_UPDATE_DOMAINS) | ||
| # Validate against invalid queries - allow users to set any query parameter |
Collaborator
There was a problem hiding this comment.
please remove unnecessary comments
| "description", | ||
| "displayName", | ||
| "sparkSettings", | ||
| INVALID_QUERIES = [ |
Collaborator
There was a problem hiding this comment.
just a thought - do we want to expose those lists to users via set --help?
| Raises: | ||
| FabricCLIError: If query is blocklisted or contains filters/wildcards. | ||
| """ | ||
| # Validate it's a simple path expression (no filters, wildcards, etc.) |
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.
This pull request refactors the validation logic for the
setcommand across all Fabric resource types. Instead of using allowlists of supported properties, the code now uses a blocklist approach: any property can be set except those explicitly blocked (either globally or per resource). This makes the CLI more flexible and aligns it with the official REST API documentation, while still preventing updates to unsafe or unsupported properties. Documentation and error handling have also been updated to reflect this new approach.Core validation logic changes:
setcommand. Now, any property can be set unless it is in a global or resource-specific blocklist, or uses filters/wildcards. This is implemented via the newvalidate_query_not_in_blocklistutility. [1] [2]id,type,workspaceId,folderId) that cannot be set for any resource, and added resource-specific blocklists where needed. [1] [2] [3] [4] [5] [6]Resource command updates:
fab_fs_set_*command modules to use the new blocklist validation function instead of allowlist validation. Removed allowlist constants from these modules. [1] [2] [3] [4] [5] [6] [7] [8]Gateway-specific validation improvements:
Documentation and error messaging:
setcommand.These changes make the CLI more robust and easier to maintain, while giving users more flexibility and clearer guidance.