diff options
| author | Joas Schilling <coding@schilljs.com> | 2022-07-22 12:54:29 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2022-07-22 13:36:00 +0300 |
| commit | 35fc94d9478a1d86bd1262db531d8d0b16f35cbb (patch) | |
| tree | 7558549e47f2734f4d711cab038b3fbfae50074f /docs | |
| parent | c36cab3f5540ae6550480fb5d587c12e1e7a1bb6 (diff) | |
Fix issues mentioned in the polls review
* Question is limited to 32k chars (not multibyte save, so an emoji is 3-4 chars)
* Json encoded options array is limited to 60k chars (not multibyte save, so an emoji is 3-4 chars)
* Options on creation are now validated to be strings
* Options array on creating needs to be at least 2 strings long
* Options on voting are now validated to be integers
* System messages `poll_voted` do not contain the actor anymore to be okay with the hidden result mode
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chat.md | 2 | ||||
| -rw-r--r-- | docs/poll.md | 32 |
2 files changed, 17 insertions, 17 deletions
diff --git a/docs/chat.md b/docs/chat.md index 5c843e059..862a7f68c 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -386,7 +386,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob * `reaction_deleted` - Reaction deleted by author (replacement of `reaction` after the action has been performed) * `reaction_revoked` - {actor} deleted a reaction (the action that will replace `reaction` with a `reaction_deleted` message) * Creating a poll is an `object_shared` with a poll object -* `poll_voted` - {actor} voted on the poll {poll} +* `poll_voted` - Someone voted on the poll {poll} * `poll_closed` - {actor} closed the poll {poll} * `message_expiration_enabled` - {actor} set the message expiration to 3 hours * `message_expiration_disabled` - {actor} disabled message expiration diff --git a/docs/poll.md b/docs/poll.md index 43b3cd210..4067d6bf6 100644 --- a/docs/poll.md +++ b/docs/poll.md @@ -18,7 +18,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` * Response: - Status code: + `201 Created` - + `400 Bad Request` When the question or the options were too long + + `400 Bad Request` When the question or the options were too long or invalid (not strings) + `403 Forbidden` When the conversation is read-only + `403 Forbidden` When the actor does not have chat permissions + `404 Not Found` When the conversation could not be found for the participant @@ -94,21 +94,21 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` It is therefor recommended to use `format=json` or send the `Content-Type: application/json` header, to receive a JSON response. -| field | type | Description | -|--------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------| -| `id` | int | ID of the poll | -| `question` | string | The question of the poll | -| `options` | string[] | The options participants can vote for | -| `votes` | int[] | Map with `'option-' + optionId` => number of votes (only available for when the actor voted on public poll or the poll is closed) | -| `actorType` | string | Actor type of the poll author (see [Constants - Attendee types](constants.md#attendee-types)) | -| `actorId` | string | Actor ID identifying the poll author | -| `actorDisplayName` | string | Display name of the poll author | -| `status` | int | Status of the poll (see [Constants - Poll status](constants.md#poll-status)) | -| `resultMode` | int | Result mode of the poll (see [Constants - Poll mode](constants.md#poll-mode)) | -| `maxVotes` | int | Maximum amount of options a user can vote for, `0` means unlimited | -| `votedSelf` | int[] | Array of option ids the participant voted for | -| `numVoters` | int | The number of unique voters that (only available for when the actor voted on public poll or the poll is closed) | -| `details` | array[] | Detailed list who voted for which option (only available for public closed polls), see [Details](#details) below | +| field | type | Description | +|--------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | int | ID of the poll | +| `question` | string | The question of the poll | +| `options` | string[] | The options participants can vote for | +| `votes` | int[] | Map with `'option-' + optionId` => number of votes (only available for when the actor voted on public poll or the poll is closed) | +| `actorType` | string | Actor type of the poll author (see [Constants - Attendee types](constants.md#attendee-types)) | +| `actorId` | string | Actor ID identifying the poll author | +| `actorDisplayName` | string | Display name of the poll author | +| `status` | int | Status of the poll (see [Constants - Poll status](constants.md#poll-status)) | +| `resultMode` | int | Result mode of the poll (see [Constants - Poll mode](constants.md#poll-mode)) | +| `maxVotes` | int | Maximum amount of options a user can vote for, `0` means unlimited | +| `votedSelf` | int[] | Array of option ids the participant voted for | +| `numVoters` | int | The number of unique voters that voted (only available when the actor voted on public poll or the poll is closed unless for the creator and moderators) | +| `details` | array[] | Detailed list who voted for which option (only available for public closed polls), see [Details](#details) below | ### Details |