diff --git a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc index 1d2f9ffdf4..f1eb222783 100644 --- a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc +++ b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc @@ -2,7 +2,7 @@ :toc: right :toclevels: 1 -include::encryption-types.adoc[leveloffset=2] +include::encryption-types.adoc[leveloffset=+1] include::enable-encryption.adoc[leveloffset=+1] diff --git a/modules/admin_manual/pages/configuration/files/encryption/index.adoc b/modules/admin_manual/pages/configuration/files/encryption/index.adoc index ab38cd6f58..743b18f1ac 100644 --- a/modules/admin_manual/pages/configuration/files/encryption/index.adoc +++ b/modules/admin_manual/pages/configuration/files/encryption/index.adoc @@ -83,7 +83,7 @@ This is, potentially, exploitable by anyone with administrator access to your se For more information, read: https://owncloud.org/blog/how-owncloud-uses-encryption-to-protect-your-data/[How ownCloud uses encryption to protect your data]. ==== -include::encryption-types.adoc[leveloffset=+1] +include::encryption-types.adoc[leveloffset=+2] == Before Enabling Encryption diff --git a/modules/admin_manual/pages/configuration/server/occ_command.adoc b/modules/admin_manual/pages/configuration/server/occ_command.adoc index 9ece235ea6..d5a45beb5d 100644 --- a/modules/admin_manual/pages/configuration/server/occ_command.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_command.adoc @@ -3326,7 +3326,7 @@ You can run migration steps with the `migrations` command. {occ-command-example-prefix} migrations:execute ---- -===== Arguments +==== Arguments [width="100%",cols="20%,70%",] |=== @@ -3334,7 +3334,7 @@ You can run migration steps with the `migrations` command. | `version` | The version to execute. |=== -===== Example +==== Example This example executes the migration step for the core app: diff --git a/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc b/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc index 6d0a2f2688..a22763a7dc 100644 --- a/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc +++ b/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc @@ -11,6 +11,7 @@ :smb2-url: https://en.wikipedia.org/wiki/Server_Message_Block#SMB_2.0 :smbclient-manpage-url: https://www.samba.org/samba/docs/man/manpages-3/smbclient.1.html :wannacry-ransomware-attack-url: https://en.wikipedia.org/wiki/WannaCry_ransomware_attack +:wnd-config-path: enterprise/external_storage/windows-network-drive_configuration.adoc == Introduction diff --git a/modules/admin_manual/pages/installation/ubuntu_18_04.adoc b/modules/admin_manual/pages/installation/ubuntu_18_04.adoc index aac7725cab..cf2069646d 100644 --- a/modules/admin_manual/pages/installation/ubuntu_18_04.adoc +++ b/modules/admin_manual/pages/installation/ubuntu_18_04.adoc @@ -207,7 +207,7 @@ include::{examplesdir}installation/ubuntu/18.04/configure-log-rotation.sh[] ==== Finalise the Installation -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}installation/ubuntu/18.04/finalise-install.sh[] ---- diff --git a/modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-valid.xml b/modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-found.xml similarity index 100% rename from modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-valid.xml rename to modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-found.xml diff --git a/modules/developer_manual/nav.adoc b/modules/developer_manual/nav.adoc index 6c6b1edfa4..ad49745ad2 100644 --- a/modules/developer_manual/nav.adoc +++ b/modules/developer_manual/nav.adoc @@ -30,7 +30,6 @@ ***** xref:webdav_api/files_versions.adoc[The Files Versions 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] diff --git a/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc b/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc index 781853bd0b..287bd26bab 100644 --- a/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc +++ b/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc @@ -1,12 +1,11 @@ -[subs="attributes+"] -[source,console] -.... +[source,console,subs="attributes+"] +---- curl --silent \ -X {request_method} \ ifdef::request_data_file[] --data "@{request_data_file}" \ endif::[] - -u {username}:{password} \ + -u {oc-examples-username}:{oc-examples-password} \ 'http://localhost/{request_base_path}/{request_path_suffix}' \ | xmllint --format - .... diff --git a/modules/developer_manual/pages/core/apis/ocs-share-api.adoc b/modules/developer_manual/pages/core/apis/ocs-share-api.adoc index d755fa362f..7e1d6b3c8a 100644 --- a/modules/developer_manual/pages/core/apis/ocs-share-api.adoc +++ b/modules/developer_manual/pages/core/apis/ocs-share-api.adoc @@ -112,7 +112,7 @@ include::{examplesdir}core/scripts/responses/shares/list-share-details-success.j Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/list-share-details.sh[] ---- @@ -120,7 +120,7 @@ include::{examplesdir}core/scripts/curl/list-share-details.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/list-share-details.php[] ---- @@ -128,7 +128,7 @@ include::{examplesdir}core/scripts/php/list-share-details.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/list-share-details.rb[] ---- @@ -136,7 +136,7 @@ include::{examplesdir}core/scripts/ruby/list-share-details.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/list-share-details.go[] ---- @@ -175,7 +175,7 @@ include::{examplesdir}core/scripts/go/list-share-details.go[] Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/get-share-info.sh[] ---- @@ -183,7 +183,7 @@ include::{examplesdir}core/scripts/curl/get-share-info.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/get-share-info.php[] ---- @@ -191,7 +191,7 @@ include::{examplesdir}core/scripts/php/get-share-info.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/get-share-info.rb[] ---- @@ -199,7 +199,7 @@ include::{examplesdir}core/scripts/ruby/get-share-info.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/get-share-info.go[] ---- @@ -207,7 +207,7 @@ include::{examplesdir}core/scripts/go/get-share-info.go[] Kotlin:: + -- -[source,kotlin,subs="attributes+"] +[source,kotlin] ---- include::{examplesdir}core/scripts/kotlin/get-share-info.kt[] ---- @@ -215,7 +215,7 @@ include::{examplesdir}core/scripts/kotlin/get-share-info.kt[] Java:: + -- -[source,java,subs="attributes+"] +[source,java] ---- include::{examplesdir}core/scripts/java/get-share-info.java[] ---- @@ -231,7 +231,7 @@ NOTE: The Java and Kotlin examples use https://github.com/square/okhttp[the squa Success:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/get-share-info-success.xml[] ---- @@ -239,7 +239,7 @@ include::{examplesdir}core/scripts/responses/shares/get-share-info-success.xml[] Failure:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/get-share-info-failure.xml[] ---- @@ -293,7 +293,7 @@ Success:: + -- .Pending share was successfully accepted -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/accept-pending-share-success.xml[] ---- @@ -302,7 +302,7 @@ Failure:: + -- .The share id does not exist. -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/accept-pending-share-failure.xml[] ---- @@ -316,7 +316,7 @@ include::{examplesdir}core/scripts/responses/shares/accept-pending-share-failure Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/accept-pending-share.sh[] ---- @@ -324,7 +324,7 @@ include::{examplesdir}core/scripts/curl/accept-pending-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/accept-pending-share.php[] ---- @@ -332,7 +332,7 @@ include::{examplesdir}core/scripts/php/accept-pending-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/accept-pending-share.rb[] ---- @@ -340,7 +340,7 @@ include::{examplesdir}core/scripts/ruby/accept-pending-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/accept-pending-share.go[] ---- @@ -423,7 +423,7 @@ a| Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/decline-pending-share.sh[] ---- @@ -431,7 +431,7 @@ include::{examplesdir}core/scripts/curl/decline-pending-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/decline-pending-share.php[] ---- @@ -439,7 +439,7 @@ include::{examplesdir}core/scripts/php/decline-pending-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/decline-pending-share.rb[] ---- @@ -447,7 +447,7 @@ include::{examplesdir}core/scripts/ruby/decline-pending-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/decline-pending-share.go[] ---- @@ -540,7 +540,7 @@ XML containing the share ID (int) of the newly created share Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/create-share.sh[] ---- @@ -548,7 +548,7 @@ include::{examplesdir}core/scripts/curl/create-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/create-share.php[] ---- @@ -556,7 +556,7 @@ include::{examplesdir}core/scripts/php/create-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/create-share.rb[] ---- @@ -564,7 +564,7 @@ include::{examplesdir}core/scripts/ruby/create-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/create-share.go[] ---- @@ -699,7 +699,7 @@ Remove the given share. Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/delete-share.sh[] ---- @@ -707,7 +707,7 @@ include::{examplesdir}core/scripts/curl/delete-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/delete-share.php[] ---- @@ -715,7 +715,7 @@ include::{examplesdir}core/scripts/php/delete-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/delete-share.rb[] ---- @@ -723,7 +723,7 @@ include::{examplesdir}core/scripts/ruby/delete-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/delete-share.go[] ---- @@ -795,7 +795,7 @@ NOTE: Only one of the update parameters can be specified at once. Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/update-share.sh[] ---- @@ -803,7 +803,7 @@ include::{examplesdir}core/scripts/curl/update-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/update-share.php[] ---- @@ -811,7 +811,7 @@ include::{examplesdir}core/scripts/php/update-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/update-share.rb[] ---- @@ -819,7 +819,7 @@ include::{examplesdir}core/scripts/ruby/update-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/update-share.go[] ---- diff --git a/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc b/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc index aa6d79c3bb..90339d6f3d 100644 --- a/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc +++ b/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc @@ -47,7 +47,7 @@ This API requires {2fa-app-url}[the 2-Factor Authentication app] to be installed Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/ocs/validate-totp.sh[] ---- @@ -77,7 +77,7 @@ If the user was not found, then: JSON:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid.json[] ---- @@ -86,7 +86,7 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid XML:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid.json[] ---- @@ -100,7 +100,7 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid JSON:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid.xml[] ---- @@ -109,7 +109,7 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid. XML:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid.xml[] ---- @@ -123,18 +123,18 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid. JSON:: + -- -[source,console,subs="attributes+"] +[source,console] ---- -include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-user-is-not-valid.json[] +include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-user-is-not-found.json[] ---- -- XML:: + -- -[source,console,subs="attributes+"] +[source,console] ---- -include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-valid.xml[] +include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-found.xml[] ---- -- ==== diff --git a/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc b/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc index 25af61c7c4..1e3619db87 100644 --- a/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc +++ b/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc @@ -1,7 +1,8 @@ === List Groups :page-partial: -:request_method: PROPFIND +:request_base_path: remote.php/dav/customgroups/groups :request_data_file: list-custom-groups.xml +:request_method: PROPFIND :request_path_suffix: // this page is included via groups.adoc diff --git a/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc b/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc index f5b6c048bb..fc9b6082ef 100644 --- a/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc +++ b/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc @@ -1,5 +1,6 @@ == Group Membership :page-partial: +:request_base_path: /remote.php/dav/customgroups/users // this page is included via groups.adoc // some variables like request_base_path used in includes here are defined there diff --git a/modules/developer_manual/pages/webdav_api/trashbin.adoc b/modules/developer_manual/pages/webdav_api/trashbin.adoc deleted file mode 100644 index 02e73fc2ee..0000000000 --- a/modules/developer_manual/pages/webdav_api/trashbin.adoc +++ /dev/null @@ -1,230 +0,0 @@ -= Trashbin API -:toc: right -:toclevels: 1 -:request-base-path: remote.php/dav/trash-bin - -== Introduction - -The trash bin API provides support for managing files in ownCloud’s trash bin. -Specifically, it provides the following functionality: - -* xref:list-files[List files in the trash bin] -* xref:delete-files[Delete files permanently from the trash bin] -* xref:restore-deleted-file[Restore deleted files to the trash bin] - -== List Files - -List all files in the trash bin - -* Path: `{request-base-path}/` -* Method: `PROPFIND` - -=== Request Parameters - -[cols=",,",options="header",] -|=== -|Attribute -|Type -|Description - -|`username` -|string -|The username of the user to list files for. -|=== - -=== Request Headers - -[cols="25%,25%,50%",options="header",] -|=== -|Header -|Type -|Description - -|`Depth` -|int -a|The maximum level to descend to, when retrieving a listing of the files in the user's trash bin. - -NOTE: Only one level of files and directories is returned if this header is omitted. -|=== - -=== Code Example - -[tabs] -==== -Curl:: -+ --- -[source,console,subs="attributes+"] -.... -include::{examplesdir}core/scripts/curl/dav/trashbin_api/list-files-in-trashbin.sh[] -.... --- -==== - -=== Returns - -This method returns an HTTP 207 (Multi-Status) status code and an XML response that contains the files in the trash bin of the authenticating user, limited to the depth specified by the `Depth` header. - -==== Example Response - -If the user that you’re connecting with is authorized, then you will see output similar to the following: - -[tabs] -==== -Curl:: -+ --- -[source,xml,subs="attributes+"] -.... -include::{examplesdir}core/webdav_api/trashbin/list-files-in-trashbin-success-response.xml[] -.... --- -==== - -== Delete Files - -Permanently delete a file from the trash bin. - -* Path: `{request-base-path}//` -* Method: `DELETE` - -=== Request Parameters - -[cols=",,",options="header",] -|=== -|Attribute -|Type -|Description - -|`username` -|string -|The username of the user to list files for. - -|`fileid` -|integer -|The id of the file to delete. -|=== - -=== Code Example - -[tabs] -==== -Curl:: -+ --- -[source,console,subs="attributes+"] -.... -include::{examplesdir}core/scripts/curl/dav/trashbin_api/delete-file-from-trashbin.sh[] -.... --- -==== - -=== Returns - -This method returns an HTTP 204 (No Content) status code, if the file is successfully deleted. -If there is no file in the trash bin with the specified file id, then an HTTP 404 (Not Found) status code is returned. - -== Restore Deleted File - -Restore a file from the trash bin. - -* Path: `{request-base-path}//` -* Method: `MOVE` - -=== Request Parameters - -[cols=",,",options="header",] -|=== -|Attribute -|Type -|Description - -|`username` -|string -|The username of the user to list files for. - -|`fileid` -|integer -|The id of the file to delete. -|=== - -=== Request Headers - -[cols="15%,15%,40%,30%",options="header",] -|=== -|Header -|Type -|Value -|Description - -|`Overwrite` -|string -|`F` or `T` -|Whether to overwrite an existing file. - -|`Destination` -|string -|`${SERVER_URI}/remote.php/dav/files//` -|The path where the file will be restored to. -|=== - -=== Code Example - -[tabs] -==== -Curl:: -+ --- -[source,console,subs="attributes+"] -.... -include::{examplesdir}core/scripts/curl/dav/trashbin_api/restore-file-to-trashbin.sh[] -.... --- -==== - -=== Returns - -==== Success - -If `Overwrite` is set to `F` and a file with the same name in the specified location does not exist, or if `Overwrite` is set to `T`, an HTTP 204 (No Content) status code will be returned, if the resource is successfully restored. - -==== File Already Exists - -If the `Overwrite` header is set to `F` and a file exists with the same name as specified in the `Destination` string, then an HTTP 412 (Precondition Failed) status code is returned, along with the following XML response: - -[source,xml] -.... - - - Sabre\DAV\Exception\PreconditionFailed - The destination node already exists, and the overwrite header is set to false - Overwrite - -.... - -==== Incorrect Overwrite Header - -If the `Overwrite` header is not set to either `T` or `F`, then an HTTP 400 (Bad Request) status code will be returned, along with the following XML response: - -[source,xml] -.... - - - Sabre\DAV\Exception\BadRequest - The HTTP Overwrite header should be either T or F - -.... - -==== Destination Directory Does Not Exist - -If the destination directory does not exist, then an HTTP 409 (Conflict) status code will be returned, along with the following XML response: - -[source,xml] -.... - - - Sabre\DAV\Exception\Conflict - The destination node is not found - -.... -