oracle / oracle/oci-cli

Docs state oci compute device list-instance supports sort-by parameter but it does not

Open
#545 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Compute
Dominant language
Python
Stars
669
Forks
236
Avg merge
1m
Merged PRs (30d)
4

Description

https://docs.oracle.com/en-us/iaas/tools/oci-cli/3.7.1/oci_cli_docs/cmdref/compute/device/list-instance.html#cmdoption-sort-by

$ oci compute device list-instance --sort-by DISPLAYNAME --instance-id <OCID>
ServiceError:
{
    "code": "InvalidParameter",
    "message": "Parameter 'sortBy' is not supported. Remove 'sortBy' parameter and try again.. Please visit https://docs.oracle.com/en-us/iaas/Content/API/References/apierrors.htm to learn more about this error code",
    "opc-request-id": "<REQUEST ID>",
    "status": 400
}
$

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked compute device list-instance command reference and reproduce the shown --sort-by invocation to compare the documentation with the service error. Confirm whether the parameter should be removed from the docs or supported by the command, then update the relevant documentation so the documented options match the verified behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.