diff --git a/docs/API_v1.0.md b/docs/API_v1.0.md index 779624e1a..9f1bcde59 100644 --- a/docs/API_v1.0.md +++ b/docs/API_v1.0.md @@ -3,7 +3,9 @@ - SPDX-License-Identifier: AGPL-3.0-or-later --> -# Polls API v1.0 +# Polls API v1.0 (final) + +Optional additions to the endpoints or its payload may occur. The Polls API is documented via the [OpenAPI](https://www.openapis.org/) specification. The generated spec files are located in the root of this repository: diff --git a/docs/Installation-help.md b/docs/Installation-help.md index c2594e59c..cd9b8153d 100644 --- a/docs/Installation-help.md +++ b/docs/Installation-help.md @@ -3,7 +3,6 @@ - SPDX-License-Identifier: AGPL-3.0-or-later --> # Update Issues -**This should be no issue anymore since v8.3.** When Polls gets updated and needs changed classes while updating a situation may occur which lets the migration fail. This is because Polls relies on its own declarative database definitions. On updates a situation now can occur where changed classes, which are used while updating, get not loaded properly and the old version of these classes are still cached and loaded. @@ -21,6 +20,8 @@ After that the site should be up again and Polls updated to the latest version. If Polls just did not get enabled and the update terminated with an error message, try to enable it again. After that Polls should be updated to the latest version. If Polls resumed back to disabled state again, keep polls disabled and please report that issue [here](https://github.com/nextcloud/polls/issues). +**This should be no issue anymore since v8.3, because Polls uses versions for schema definitions wich force the updater to use the new/changed classes.** + # Installation variants ## Install via Git If you want to run the latest development version from git source, you need to clone the repo to your apps folder: diff --git a/docs/occ.md b/docs/occ.md index fab7c9648..69887b3ad 100644 --- a/docs/occ.md +++ b/docs/occ.md @@ -8,10 +8,15 @@ Note: In any case make sure you have a backup of your database and only use thes All commands require polls to be enabled and are not available after uninstall or while in maintenance mode. ## Overview +### Nextcloud core commends that affect Polls |Command|Description| |-|-| |[`db:add-missing-indices`](#create-optional-indices) | Create optional indices (NC core command) | |[`maintenance:repair`](#run-repair-steps) | Run Polls post-migration repair steps (NC core command) | + +### Polls only related commands +|Command|Description| +|-|-| |[`polls:index:remove:foreign-key-constraints`](#remove-foreign-key-constraints) | Remove foreign key constraints | |[`polls:index:remove:unique-indices`](#remove-unique-indices) | Remove unique indices | |[`polls:index:remove:optional`](#remove-optional-indices) | Remove optional indices |