-
Notifications
You must be signed in to change notification settings - Fork 1
SP-45: Add asset-registry validate command #342
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Zgjim Haziri (ZgjimHaziri)
wants to merge
1
commit into
main
Choose a base branch
from
SP-45-add-asset-registry-validate-command
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,6 +71,51 @@ Options: | |
| - `--assetType <assetType>` (required) – The asset type identifier | ||
| - `--json` – Write the schema to a JSON file in the working directory | ||
|
|
||
| ## Validate | ||
|
|
||
| Validate asset configurations against the asset service's validation endpoint. | ||
|
|
||
| ### Validate a configuration before import | ||
|
|
||
| Provide the configuration JSON inline or via a file. The CLI wraps it into the `ValidateRequest` envelope for you. | ||
|
|
||
| ``` | ||
| content-cli asset-registry validate --assetType BOARD_V2 \ | ||
| --packageKey my-pkg --configuration '{"components":[{"type":"kpi"}]}' | ||
| ``` | ||
|
|
||
| ``` | ||
| content-cli asset-registry validate --assetType BOARD_V2 \ | ||
| --packageKey my-pkg -c config.json | ||
| ``` | ||
|
|
||
| ### Validate an already-stored node | ||
|
|
||
| ``` | ||
| content-cli asset-registry validate --assetType BOARD_V2 \ | ||
| --packageKey my-pkg --nodeKey my-view | ||
| ``` | ||
|
|
||
| ### Full request from file | ||
|
|
||
| For multi-node validation or other advanced use, provide a JSON file containing the entire `ValidateRequest` body. | ||
|
|
||
| ``` | ||
| content-cli asset-registry validate --assetType BOARD_V2 -f request.json | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| - `--assetType <assetType>` (required) – The asset type identifier | ||
| - `--packageKey <packageKey>` – Package key containing the node | ||
| - `--nodeKey <nodeKey>` – Key of an already-stored node to validate on the platform | ||
| - `--configuration <configuration>` – Inline JSON of the configuration to validate before import | ||
| - `-c, --configFile <configFile>` – Path to a JSON file containing the configuration to validate before import | ||
|
Comment on lines
+112
to
+113
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the short hand looks very confusing considering we have both --configuration and --configFile. I would just remove it here and leave no short hand |
||
| - `-f, --file <file>` – Path to a JSON file containing a full ValidateRequest (alternative to all other options) | ||
| - `--json` – Write the validation response to a JSON file in the working directory | ||
|
|
||
| The options `--nodeKey`, `--configuration`/`-c`, and `-f` are mutually exclusive. | ||
|
|
||
| ## Get Examples | ||
|
|
||
| Fetch example configurations for an asset type. Not all asset types provide examples. | ||
|
|
||
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What was the reason for enabling configuration passing directly instead of using a file? I expect this to be very unusable even for an agent to do