docs: fix shell help text to use resource:<uri> instead of resource:<name> #83
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
…name> The shell command's resource shorthand expects a URI parameter, not a name. This updates the help text to accurately reflect this requirement, helping users avoid the 'Invalid request parameters' error when trying to read resources by name instead of URI.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The shell command's resource shorthand expects a URI parameter, not a name. This causes confusion when users try to use
resource:4Cs.pdf(using the NAME column from the resources list) and receive an 'Invalid request parameters' error.Solution
Updated the help text to accurately reflect that the command requires a URI:
resource:<name>toresource:<uri>Example
Before: Users might try
resource:4Cs.pdf(which fails)After: Users will understand they need to use
resource:http://0.0.0.0:7860/api/v2/files/002ebfc2-e408-41e6-bce5-2d28a91220bfThis is a documentation-only change that helps users understand the correct syntax.