Improve parameter type representations in OCI CLI help #1027
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.
Summary
This PR improves how parameter types are displayed in the OCI CLI help text, making it clearer what kind of input each parameter expects.
Changes
1. New CliOcidType for OCID Parameters
OCIDinstead ofTEXTin help text2. Enhanced CliComplexType for JSON Parameters
JSONinstead ofCOMPLEX TYPEExamples
Before:
After:
Testing
Tested locally with:
The parameter types now clearly indicate whether they expect an OCID or JSON input, improving the user experience.
Impact
Files Changed
src/oci_cli/custom_types/cli_ocid_type.py- New OCID typesrc/oci_cli/custom_types/cli_complex_type.py- Enhanced for JSON displaysrc/oci_cli/custom_types/__init__.py- Export new type