[
https://issues.apache.org/jira/browse/HDFS-12047?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16065997#comment-16065997
]
Weiwei Yang commented on HDFS-12047:
------------------------------------
Hi [~anu]
Thank you for the comments
bq. should we compare with doc with the ozone-user spec (ozone-user.pdf in
HDFS-7240) and make sure that all the responses are correct
I tested each rest call along with the design doc. Most of them are working as
expected, some small mismatches I've found are listed below
# For list API parameters, e.g listVolume, listBucket and listKey, the design
doc was {{prefix}}, {{max_keys}}, {{prev_key}} and {{root_scan}}. However the
implementation was using {{prefix}}, {{max-keys}}, {{prev-key}} and
{{root-scan}} (not it uses dash instead of under score), which are defined in
{{Header#OZONE_LIST_QUERY_MAXKEYS}} and {{Header#OZONE_LIST_QUERY_PREVKEY}}.
# Design doc page 22, listVolume API allows parameter {{root_scan}} and its
value is 1 or 0. But this is actually a bool value, so the value should be true
or false.
I did not see any more obvious mismatch out there, though I haven't verified
all the error codes and reply headers. For this 2, do you want to fix the
design doc or the implementation?
Thanks
> Ozone: Add REST API documentation
> ---------------------------------
>
> Key: HDFS-12047
> URL: https://issues.apache.org/jira/browse/HDFS-12047
> Project: Hadoop HDFS
> Issue Type: Sub-task
> Components: ozone
> Reporter: Weiwei Yang
> Assignee: Weiwei Yang
> Labels: documentation
> Attachments: HDFS-12047-HDFS-7240.001.patch
>
>
> Add ozone rest api documentation.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
