Standardize parameter naming based on service name; relegate legacy parameter names to OCI_CLI_PARAM_ALIASES
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 669
- Forks
- 236
- Avg merge
- 1m
- Merged PRs (30d)
- 4
Description
Consider standardizing convention for parameter names according to service name. For example, this command is predictable using the service name in part for the key parameter name
oci network drg get --drg-id <value> #--drg-id is obvious for service drg
However, this command uses a non-predictable key parameter
oci network route-table get --rt-id <value> #would expect route-table service uses --route-table-id parameter not --rt-id
I would expect this to use a similar convention and instead require --route-table-id as input. There are many existing services that follow this convention well. For example:
oci network cross-connect get --cross-connect-id <value>
oci network local-peering-gateway get --local-peering-gateway-id <value>
oci compute-management instance-configuration get --instance-configuration-id <value>
I see this throughout and suggest deprecating mismatched inputs in favor of more verbose yet aligned names. For example:
- Deprecate
oci network route-table get --rt-idin favor of--route-table-id - Deprecate
oci network dhcp-options get --dhcp-idin favor of--dhcp-options-id - Deprecate
oci network ip-sec-tunnel get --ipsc-idin favor of--ip-sec-tunnel-id - …and so on
As is done with other verbose parameter names, default entries for OCI_CLI_PARAM_ALIASES in ~/.oci/config could be created to ease the transition. Certainly, each person may choose their own custom aliases still as needed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying the listed OCI CLI commands and the existing OCI_CLI_PARAM_ALIASES behavior; the issue does not name implementation files or tests. Define the complete set of mismatched parameters and the transition expectations. Done means service-aligned parameter names are supported across the affected commands while legacy names remain available through aliases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, cloud
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100