[ 
https://issues.apache.org/jira/browse/HDDS-10841?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Hemant Kumar updated HDDS-10841:
--------------------------------
    Description: 
Unlikely other pagination APIs (list volume, bucket, keys, etc) snapshot diff 
CLI help doesn't print default (or max) values for page-size.
List bucket CLI help:
{code:java}
Usage: ozone sh bucket list [-hV] [--has-snapshot] [-p=<prefix>]
                            [-s=<startItem>] [[-l=<limit>] | [-a]] <value>
lists the buckets in a volume.
      <value>               URI of the volume.
                            Ozone URI could either be a full URI or short URI.
                            Full URI should start with o3://, in case of non-HA
                            clusters it should be followed by the host name and
                            optionally the port number. In case of HA clusters
                            the service id should be used. Service id provides a
                            logical name for multiple hosts and it is defined
                            in the property ozone.om.service.ids.
                            Example of a full URI with host name and port number
                            for a key:
                            o3://omhostname:9862/vol1/bucket1/key1
                            With a service id for a volume:
                            o3://omserviceid/vol1/
                            Short URI should start from the volume.
                            Example of a short URI for a bucket:
                            vol1/bucket1
                            Any unspecified information will be identified from
                            the config files.  -a, --all                 List 
all results
  -h, --help                Show this help message and exit.
      --has-snapshot        Only show buckets that have at least one active
                              snapshot.
  -l, --length=<limit>      Maximum number of items to list
                              Default: 100
  -p, --prefix=<prefix>     Prefix to filter the items
  -s, --start=<startItem>   The item to start the listing from.
                            This will be excluded from the result.
  -V, --version             Print version information and exit. {code}
Snapshot diff CLI help.
{code:java}
Usage: ozone sh snapshot diff [-chV] [-p=<pageSize>] [-t=<token>] <value>
                              <fromSnapshot> <toSnapshot>
Get the differences between two snapshots
      <value>           URI of the volume/bucket.
                        Ozone URI could either be a full URI or short URI.
                        Full URI should start with o3://, in case of non-HA
                        clusters it should be followed by the host name and
                        optionally the port number. In case of HA clusters
                        the service id should be used. Service id provides a
                        logical name for multiple hosts and it is defined
                        in the property ozone.om.service.ids.
                        Example of a full URI with host name and port number
                        for a key:
                        o3://omhostname:9862/vol1/bucket1/key1
                        With a service id for a volume:
                        o3://omserviceid/vol1/
                        Short URI should start from the volume.
                        Example of a short URI for a bucket:
                        vol1/bucket1
                        Any unspecified information will be identified from
                        the config files.
      <fromSnapshot>    from snapshot name
      <toSnapshot>      to snapshot name
  -c, --cancel          Request to cancel a running SnapshotDiff job. If the
                          job is not IN_PROGRESS, the request will fail.
  -h, --help            Show this help message and exit.
  -p, --page-size=<pageSize>
                        number of diff entries to be returned in the response
                          (optional)
  -t, --token=<token>   continuation token for next page (optional)
  -V, --version         Print version information and exit. {code}

  was:
Unlikely other pagination APIs (list volume, bucket, keys, etc) snapshot diff 
CLI help doesn't print default values for page-size.
List bucket CLI help:
{code:java}
Usage: ozone sh bucket list [-hV] [--has-snapshot] [-p=<prefix>]
                            [-s=<startItem>] [[-l=<limit>] | [-a]] <value>
lists the buckets in a volume.
      <value>               URI of the volume.
                            Ozone URI could either be a full URI or short URI.
                            Full URI should start with o3://, in case of non-HA
                            clusters it should be followed by the host name and
                            optionally the port number. In case of HA clusters
                            the service id should be used. Service id provides a
                            logical name for multiple hosts and it is defined
                            in the property ozone.om.service.ids.
                            Example of a full URI with host name and port number
                            for a key:
                            o3://omhostname:9862/vol1/bucket1/key1
                            With a service id for a volume:
                            o3://omserviceid/vol1/
                            Short URI should start from the volume.
                            Example of a short URI for a bucket:
                            vol1/bucket1
                            Any unspecified information will be identified from
                            the config files.  -a, --all                 List 
all results
  -h, --help                Show this help message and exit.
      --has-snapshot        Only show buckets that have at least one active
                              snapshot.
  -l, --length=<limit>      Maximum number of items to list
                              Default: 100
  -p, --prefix=<prefix>     Prefix to filter the items
  -s, --start=<startItem>   The item to start the listing from.
                            This will be excluded from the result.
  -V, --version             Print version information and exit. {code}
Snapshot diff CLI help.
{code:java}
Usage: ozone sh snapshot diff [-chV] [-p=<pageSize>] [-t=<token>] <value>
                              <fromSnapshot> <toSnapshot>
Get the differences between two snapshots
      <value>           URI of the volume/bucket.
                        Ozone URI could either be a full URI or short URI.
                        Full URI should start with o3://, in case of non-HA
                        clusters it should be followed by the host name and
                        optionally the port number. In case of HA clusters
                        the service id should be used. Service id provides a
                        logical name for multiple hosts and it is defined
                        in the property ozone.om.service.ids.
                        Example of a full URI with host name and port number
                        for a key:
                        o3://omhostname:9862/vol1/bucket1/key1
                        With a service id for a volume:
                        o3://omserviceid/vol1/
                        Short URI should start from the volume.
                        Example of a short URI for a bucket:
                        vol1/bucket1
                        Any unspecified information will be identified from
                        the config files.
      <fromSnapshot>    from snapshot name
      <toSnapshot>      to snapshot name
  -c, --cancel          Request to cancel a running SnapshotDiff job. If the
                          job is not IN_PROGRESS, the request will fail.
  -h, --help            Show this help message and exit.
  -p, --page-size=<pageSize>
                        number of diff entries to be returned in the response
                          (optional)
  -t, --token=<token>   continuation token for next page (optional)
  -V, --version         Print version information and exit. {code}


> Snapshot diff CLI help should prints default value for paramaters
> -----------------------------------------------------------------
>
>                 Key: HDDS-10841
>                 URL: https://issues.apache.org/jira/browse/HDDS-10841
>             Project: Apache Ozone
>          Issue Type: Sub-task
>            Reporter: Hemant Kumar
>            Priority: Major
>
> Unlikely other pagination APIs (list volume, bucket, keys, etc) snapshot diff 
> CLI help doesn't print default (or max) values for page-size.
> List bucket CLI help:
> {code:java}
> Usage: ozone sh bucket list [-hV] [--has-snapshot] [-p=<prefix>]
>                             [-s=<startItem>] [[-l=<limit>] | [-a]] <value>
> lists the buckets in a volume.
>       <value>               URI of the volume.
>                             Ozone URI could either be a full URI or short URI.
>                             Full URI should start with o3://, in case of 
> non-HA
>                             clusters it should be followed by the host name 
> and
>                             optionally the port number. In case of HA clusters
>                             the service id should be used. Service id 
> provides a
>                             logical name for multiple hosts and it is defined
>                             in the property ozone.om.service.ids.
>                             Example of a full URI with host name and port 
> number
>                             for a key:
>                             o3://omhostname:9862/vol1/bucket1/key1
>                             With a service id for a volume:
>                             o3://omserviceid/vol1/
>                             Short URI should start from the volume.
>                             Example of a short URI for a bucket:
>                             vol1/bucket1
>                             Any unspecified information will be identified 
> from
>                             the config files.  -a, --all                 List 
> all results
>   -h, --help                Show this help message and exit.
>       --has-snapshot        Only show buckets that have at least one active
>                               snapshot.
>   -l, --length=<limit>      Maximum number of items to list
>                               Default: 100
>   -p, --prefix=<prefix>     Prefix to filter the items
>   -s, --start=<startItem>   The item to start the listing from.
>                             This will be excluded from the result.
>   -V, --version             Print version information and exit. {code}
> Snapshot diff CLI help.
> {code:java}
> Usage: ozone sh snapshot diff [-chV] [-p=<pageSize>] [-t=<token>] <value>
>                               <fromSnapshot> <toSnapshot>
> Get the differences between two snapshots
>       <value>           URI of the volume/bucket.
>                         Ozone URI could either be a full URI or short URI.
>                         Full URI should start with o3://, in case of non-HA
>                         clusters it should be followed by the host name and
>                         optionally the port number. In case of HA clusters
>                         the service id should be used. Service id provides a
>                         logical name for multiple hosts and it is defined
>                         in the property ozone.om.service.ids.
>                         Example of a full URI with host name and port number
>                         for a key:
>                         o3://omhostname:9862/vol1/bucket1/key1
>                         With a service id for a volume:
>                         o3://omserviceid/vol1/
>                         Short URI should start from the volume.
>                         Example of a short URI for a bucket:
>                         vol1/bucket1
>                         Any unspecified information will be identified from
>                         the config files.
>       <fromSnapshot>    from snapshot name
>       <toSnapshot>      to snapshot name
>   -c, --cancel          Request to cancel a running SnapshotDiff job. If the
>                           job is not IN_PROGRESS, the request will fail.
>   -h, --help            Show this help message and exit.
>   -p, --page-size=<pageSize>
>                         number of diff entries to be returned in the response
>                           (optional)
>   -t, --token=<token>   continuation token for next page (optional)
>   -V, --version         Print version information and exit. {code}



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to