Improve parameter type representations in OCI CLI help#1027
Open
mgajda wants to merge 3 commits intooracle:masterfrom
Open
Improve parameter type representations in OCI CLI help#1027mgajda wants to merge 3 commits intooracle:masterfrom
mgajda wants to merge 3 commits intooracle:masterfrom
Conversation
|
Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application. When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated. If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public. |
This commit introduces improvements to how parameter types are displayed in the OCI CLI help text: 1. Added new CliOcidType custom type for OCID parameters - OCID parameters now show as "OCID" instead of "TEXT" in help - Covers 284 service files with OCID parameter updates - Helps users understand which parameters expect Oracle Cloud Identifiers 2. Enhanced CliComplexType to show "JSON" instead of "COMPLEX TYPE" - Complex parameters now clearly indicate they expect JSON input - Added support for schema-specific type hints (future enhancement) - Updated help text to clarify JSON object expectation These changes improve the user experience by providing clearer type information in command help text, making it easier to understand what kind of input each parameter expects.
c327fa7 to
ebae7f3
Compare
|
Thank you for signing the OCA. |
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.
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