[ 
https://issues.apache.org/jira/browse/HDDS-7169?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17733010#comment-17733010
 ] 

Abhishek Pal edited comment on HDDS-7169 at 6/15/23 3:39 PM:
-------------------------------------------------------------

h3. Expected Endpoints
*GET*: <BASE_URL>/filebrowser/path={*}
*DEFAULT PATH* = root:// (this is a placeholder for whatever root directory 
might be present in the machine and accessible to the user)
----
h3. 
Expected Response
{code:java}
{
  "path": "root://",
  "users": "",
  "groups": "",
  "pageSize": 45,
  "pageDetails": {
    "currentPage": 0,
    "lastPage": 2
  },
  "files": [
    {
      "path": "root://",
      "name": ".",
      "users": "",
      "groups": "",
      "stats": {
        "createdTime": null,
        "bucketParam": "s3",
        "volumePermissions": "access to vol1?"
      },
      "modifiedTime": "",
      "size": 0,
      "type": "dir",
      "permissions": "drwxrwxrwx"
    },
    {
      "path": "root://demo-ozone",
      "name": "demo-ozone",
      "users": "rootuser",
      "groups": "somegroup",
      "stats": {
        "createdTime": null,
        "bucketParam": "s3buck",
        "volumePermissions": "access to vol2?"
      },
      "modifiedTime": "",
      "size": 0,
      "type": "dir",
      "permissions": "drwxrwxrwx"
    },
    {
      "path": "root://test-ozone",
      "name": "test-ozone",
      "users": "",
      "groups": "",
      "stats": {
        "createdTime": null,
        "bucketParam": "s3buck",
        "volumePermissions": "access to vol2?"
      },
      "modifiedTime": "",
      "size": 0,
      "type": "dir",
      "permissions": "drwxrwxrwx"
    }
  ],
  "modifiedTime": 1234560000,
  "permissions": "drwxrwxrwx"
}
{code}
----
h3. Understanding the response

This response mainly has the following objects of importance:
 - {*}path{*}: This will be used to keep track of the paths of the 
files/folders (will refer to the full path of the associated entity)
 - {*}pageSize{*}: Represent the result size/maximum number of records (i.e. 
files/folders) found
 - {*}pageDetails{*}: Stores the active page, last page that can be fetched
 - {*}files{*}: This is an array of the files/folders present under the root 
path
 - {*}stats{*}: Will store metadata for the records (file/folder metadata like 
bucket params, volume info etc.)


was (Author: JIRAUSER291782):
h3. Expected Response
{code}
{
  "path": "root://",
  "users": "",
  "groups": "",
  "pageSize": 45,
  "pageDetails": {
    "currentPage": 0,
    "lastPage": 2
  },
  "files": [
    {
      "path": "root://",
      "name": ".",
      "users": "",
      "groups": "",
      "stats": {
        "createdTime": null,
        "bucketParam": "s3",
        "volumePermissions": "access to vol1?"
      },
      "modifiedTime": "",
      "size": 0,
      "type": "dir",
      "permissions": "drwxrwxrwx"
    },
    {
      "path": "root://demo-ozone",
      "name": "demo-ozone",
      "users": "rootuser",
      "groups": "somegroup",
      "stats": {
        "createdTime": null,
        "bucketParam": "s3buck",
        "volumePermissions": "access to vol2?"
      },
      "modifiedTime": "",
      "size": 0,
      "type": "dir",
      "permissions": "drwxrwxrwx"
    },
    {
      "path": "root://test-ozone",
      "name": "test-ozone",
      "users": "",
      "groups": "",
      "stats": {
        "createdTime": null,
        "bucketParam": "s3buck",
        "volumePermissions": "access to vol2?"
      },
      "modifiedTime": "",
      "size": 0,
      "type": "dir",
      "permissions": "drwxrwxrwx"
    }
  ],
  "modifiedTime": 1234560000,
  "permissions": "drwxrwxrwx"
}
{code}
----
h3. Understanding the response

This response mainly has the following objects of importance:
- *path*: This will be used to keep track of the paths of the files/folders 
(will refer to the full path of the associated entity)
- *pageSize*: Represent the result size/maximum number of records (i.e. 
files/folders) found
- *pageDetails*: Stores the active page, last page that can be fetched
- *files*: This is an array of the files/folders present under the root path
- *stats*: Will store metadata for the records (file/folder metadata like 
bucket params, volume info etc.)



> Recon: Add a file browser
> -------------------------
>
>                 Key: HDDS-7169
>                 URL: https://issues.apache.org/jira/browse/HDDS-7169
>             Project: Apache Ozone
>          Issue Type: Sub-task
>            Reporter: Siyao Meng
>            Assignee: Abhishek Pal
>            Priority: Major
>
> Something like Hue file browser, but should be responsive, and be able to 
> display extra info elegantly (key blocks information, bucket parameters, 
> volume permissions, and so on).
> Pending further discussion.



--
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