diff options
author | 2023-11-09 13:06:37 +0100 | |
---|---|---|
committer | 2023-11-09 12:06:37 +0000 | |
commit | 42a19cf390bc1b3be1331f9bce79c8372f687a77 (patch) | |
tree | ef4c099e81a06af254be2cc491e34d83050444b8 /internal/api/model/poll.go | |
parent | [bugfix] actually decrement votes during poll vote delete ... (#2344) (diff) | |
download | gotosocial-42a19cf390bc1b3be1331f9bce79c8372f687a77.tar.xz |
[bugfix/docs] Poll api fixups + swagger docs (#2345)
Diffstat (limited to 'internal/api/model/poll.go')
-rw-r--r-- | internal/api/model/poll.go | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/internal/api/model/poll.go b/internal/api/model/poll.go index ca479d117..c1d2ca89e 100644 --- a/internal/api/model/poll.go +++ b/internal/api/model/poll.go @@ -41,10 +41,15 @@ type Poll struct { VotersCount int `json:"voters_count"` // When called with a user token, has the authorized user voted? - Voted bool `json:"voted,omitempty"` + // + // Omitted when no user token provided. + Voted *bool `json:"voted,omitempty"` - // When called with a user token, which options has the authorized user chosen? Contains an array of index values for options. - OwnVotes []int `json:"own_votes,omitempty"` + // When called with a user token, which options has the authorized + // user chosen? Contains an array of index values for options. + // + // Omitted when no user token provided. + OwnVotes *[]int `json:"own_votes,omitempty"` // Possible answers for the poll. Options []PollOption `json:"options"` @@ -66,7 +71,7 @@ type PollOption struct { // PollRequest models a request to create a poll. // -// swagger:parameters createStatus +// swagger:model pollRequest type PollRequest struct { // Array of possible answers. // If provided, media_ids cannot be used, and poll[expires_in] must be provided. @@ -86,7 +91,7 @@ type PollRequest struct { // PollVoteRequest models a request to vote in a poll. // -// swagger:parameters pollVote +// swagger:ignore type PollVoteRequest struct { // Choices contains poll vote choice indices. Note that form // uses a different key than the JSON, i.e. the '[]' suffix. |