Skip to content

Document The New Trash bin WebDAV API in 10.3 #1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
settermjd merged 2 commits into from
Jul 11, 2019
Merged

Document The New Trash bin WebDAV API in 10.3 #1400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1915eed
Document The New Trash bin WebDAV API in 10.3
settermjd Jul 9, 2019
8dee0f6
Merge branch 'master' into document-trashbin-api
settermjd Jul 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions ...developer_manual/examples/core/scripts/curl/dav/trashbin_api/delete-file-from-trashbin.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/bin/bash

##
## Variable Declaration
##
FILE_ID=11111
USERNAME={oc-examples-username}
PASSWORD={oc-examples-password}
API_PATH="remote.php/dav/trash-bin/${USERNAME}/${FILE_ID}"
SERVER_URI="{oc-examples-server-url}"

curl '$SERVER_URI/$API_PATH/' \
-X DELETE \
--user "${USERNAME}:${PASSWORD}"
29 changes: 29 additions & 0 deletions ...es/developer_manual/examples/core/scripts/curl/dav/trashbin_api/list-files-in-trashbin.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/usr/bin/env bash

##
## Variable Declaration
##
USERNAME={oc-examples-username}
PASSWORD={oc-examples-password}
API_PATH="remote.php/dav/trash-bin/<username>"
SERVER_URI="{oc-examples-server-url}"
REQUEST_BODY=$(cat <<EOF
<?xml version="1.0"?>
<d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
<d:prop>
<oc:trashbin-original-filename />
<oc:trashbin-original-location />
<oc:trashbin-delete-datetime />
<d:getcontentlength />
<d:resourcetype />
</d:prop>
</d:propfind>
EOF
)

curl '$SERVER_URI/$API_PATH/' \
-H 'Content-Type: application/xml; charset=UTF-8' \
-H 'Depth: 1' \
-X PROPFIND \
--data-binary "${REQUEST_BODY}" \
--user "${USERNAME}:${PASSWORD}"
15 changes: 15 additions & 0 deletions .../developer_manual/examples/core/scripts/curl/dav/trashbin_api/restore-file-to-trashbin.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash

##
## Variable Declaration
##
USERNAME={oc-examples-username}
PASSWORD={oc-examples-password}
API_PATH="remote.php/dav/trash-bin/${USERNAME}/${FILE_ID}"
SERVER_URI="{oc-examples-server-url}"

curl '$SERVER_URI/$API_PATH/' \
-H 'Overwrite: F' \
-H 'Destination: ${SERVER_URI}/remote.php/dav/files/${USERNAME}/<filepath>' \
-X MOVE \
--user "${USERNAME}:${PASSWORD}"
122 changes: 122 additions & 0 deletions ...oper_manual/examples/core/webdav_api/trashbin/list-files-in-trashbin-success-response.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<?xml version="1.0"?>
<d:multistatus xmlns:d="DAV:" xmlns:s="http://sabredav.org/ns" xmlns:oc="http://owncloud.org/ns">
<d:response>
<d:href>/remote.php/dav/trash-bin/admin/</d:href>
Comment thread
settermjd marked this conversation as resolved.
<d:propstat>
<d:prop>
<d:resourcetype>
<d:collection/>
</d:resourcetype>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
<d:propstat>
<d:prop>
<oc:trashbin-original-filename/>
<oc:trashbin-original-location/>
<oc:trashbin-delete-datetime/>
<d:getcontentlength/>
</d:prop>
<d:status>HTTP/1.1 404 Not Found</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/remote.php/dav/trash-bin/admin/255/</d:href>
<d:propstat>
<d:prop>
<oc:trashbin-original-filename>Level 1</oc:trashbin-original-filename>
<oc:trashbin-original-location>Level 1</oc:trashbin-original-location>
<oc:trashbin-delete-datetime>Tue, 09 Jul 2019 08:26:38 GMT</oc:trashbin-delete-datetime>
<d:resourcetype>
<d:collection/>
</d:resourcetype>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
<d:propstat>
<d:prop>
<d:getcontentlength/>
</d:prop>
<d:status>HTTP/1.1 404 Not Found</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/remote.php/dav/trash-bin/admin/255/256/</d:href>
<d:propstat>
<d:prop>
<oc:trashbin-original-filename>Level 2</oc:trashbin-original-filename>
<oc:trashbin-original-location>Level 1/Level 2</oc:trashbin-original-location>
<oc:trashbin-delete-datetime>Tue, 09 Jul 2019 08:26:38 GMT</oc:trashbin-delete-datetime>
<d:resourcetype>
<d:collection/>
</d:resourcetype>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
<d:propstat>
<d:prop>
<d:getcontentlength/>
</d:prop>
<d:status>HTTP/1.1 404 Not Found</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/remote.php/dav/trash-bin/admin/255/256/257/</d:href>
<d:propstat>
<d:prop>
<oc:trashbin-original-filename>Level 3</oc:trashbin-original-filename>
<oc:trashbin-original-location>Level 1/Level 2/Level 3</oc:trashbin-original-location>
<oc:trashbin-delete-datetime>Tue, 09 Jul 2019 08:26:38 GMT</oc:trashbin-delete-datetime>
<d:resourcetype>
<d:collection/>
</d:resourcetype>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
<d:propstat>
<d:prop>
<d:getcontentlength/>
</d:prop>
<d:status>HTTP/1.1 404 Not Found</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/remote.php/dav/trash-bin/admin/255/256/257/263</d:href>
<d:propstat>
<d:prop>
<oc:trashbin-original-filename>test.txt</oc:trashbin-original-filename>
<oc:trashbin-original-location>Level 1/Level 2/Level 3/test.txt</oc:trashbin-original-location>
<oc:trashbin-delete-datetime>Tue, 09 Jul 2019 08:26:38 GMT</oc:trashbin-delete-datetime>
<d:getcontentlength>34</d:getcontentlength>
<d:resourcetype/>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/remote.php/dav/trash-bin/admin/123</d:href>
<d:propstat>
<d:prop>
<oc:trashbin-original-filename>git-image-one.png</oc:trashbin-original-filename>
<oc:trashbin-original-location>git-image-one.png</oc:trashbin-original-location>
<oc:trashbin-delete-datetime>Tue, 09 Jul 2019 08:15:55 GMT</oc:trashbin-delete-datetime>
<d:getcontentlength>1067792</d:getcontentlength>
<d:resourcetype/>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/remote.php/dav/trash-bin/admin/119</d:href>
<d:propstat>
<d:prop>
<oc:trashbin-original-filename>git-image-one.png</oc:trashbin-original-filename>
<oc:trashbin-original-location>git-image-one.png</oc:trashbin-original-location>
<oc:trashbin-delete-datetime>Tue, 09 Jul 2019 08:17:54 GMT</oc:trashbin-delete-datetime>
<d:getcontentlength>1517914</d:getcontentlength>
<d:resourcetype/>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
</d:multistatus>
3 changes: 2 additions & 1 deletion modules/developer_manual/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@
***** xref:webdav_api/comments.adoc[The Comments API]
***** xref:webdav_api/groups.adoc[The Custom Groups Management API]
***** xref:webdav_api/files_versions.adoc[The Files Versions API]
***** xref:webdav_api/tags.adoc[The Tags API]
***** xref:webdav_api/search.adoc[The Search API]
***** xref:webdav_api/tags.adoc[The Tags API]
***** xref:webdav_api/trashbin.adoc[The Trash Bin API]
** xref:app/introduction.adoc[Application Development]
*** xref:app/fundamentals/index.adoc[Fundamental Concepts]
**** xref:app/fundamentals/info.adoc[Application Metadata]
Expand Down
Loading