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

Marcus Christie updated AIRAVATA-3033:
--------------------------------------
    Description: 
h5. API design notes
* URL is a user storage relative path, for example 
{{/api/user-storage/~/TestOct1/Gaussian_on_May_22_2019_1136_AM}}
* paths are always directories
* GET on a path returns a JSON response with two keys {{directories}} and 
{{files}}
* POSTing to a missing path creates the path
* POST is always a multipart/form-data request and may contain file uploads
* DELETE must be to an existing path and will delete that path
* downloading a file requires using /api/download with the data product URI
* PUT to a new path creates the path. Request body must be JSON with 
{{directories}} and {{files}} to move to new or existing path.
* With PUT requests, the JSON object for a directory or file can also have a 
{{rename}} key to support renames


  was:
h5. API design notes
* URL is a user storage relative path, for example 
{{/api/user-storage/~/TestOct1/Gaussian_on_May_22_2019_1136_AM}}
* paths are always directories
* GET on a path returns a JSON response with two keys {{directories}} and 
{{files}}
* POSTing to a missing path creates the path
* POST is always a multipart/form-data request and may contain file uploads
* DELETE must be to an existing path and the body must be a JSON object with 
{{directories}} and {{files}} to be deleted
* downloading a file requires using /api/download with the data product URI
* PUT to a new path creates the path. Request body must be JSON with 
{{directories}} and {{files}} to move to new or existing path.
* With PUT requests, the JSON object for a directory or file can also have a 
{{rename}} key to support renames



> REST API for viewing, modifying user storage
> --------------------------------------------
>
>                 Key: AIRAVATA-3033
>                 URL: https://issues.apache.org/jira/browse/AIRAVATA-3033
>             Project: Airavata
>          Issue Type: Sub-task
>          Components: Django Portal
>            Reporter: Marcus Christie
>            Assignee: Marcus Christie
>            Priority: Major
>             Fix For: 0.19
>
>
> h5. API design notes
> * URL is a user storage relative path, for example 
> {{/api/user-storage/~/TestOct1/Gaussian_on_May_22_2019_1136_AM}}
> * paths are always directories
> * GET on a path returns a JSON response with two keys {{directories}} and 
> {{files}}
> * POSTing to a missing path creates the path
> * POST is always a multipart/form-data request and may contain file uploads
> * DELETE must be to an existing path and will delete that path
> * downloading a file requires using /api/download with the data product URI
> * PUT to a new path creates the path. Request body must be JSON with 
> {{directories}} and {{files}} to move to new or existing path.
> * With PUT requests, the JSON object for a directory or file can also have a 
> {{rename}} key to support renames



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to