summaryrefslogtreecommitdiff
path: root/internal/api
diff options
context:
space:
mode:
Diffstat (limited to 'internal/api')
-rw-r--r--internal/api/client/polls/polls_vote.go10
-rw-r--r--internal/api/model/poll.go15
-rw-r--r--internal/api/model/status.go2
3 files changed, 20 insertions, 7 deletions
diff --git a/internal/api/client/polls/polls_vote.go b/internal/api/client/polls/polls_vote.go
index 8773d0606..824ea08ef 100644
--- a/internal/api/client/polls/polls_vote.go
+++ b/internal/api/client/polls/polls_vote.go
@@ -27,7 +27,7 @@ import (
"github.com/superseriousbusiness/gotosocial/internal/oauth"
)
-// PollVotePOSTHandler swagger:operation POST /api/v1/polls/{id}/vote poll
+// PollVotePOSTHandler swagger:operation POST /api/v1/polls/{id}/vote pollVote
//
// Vote with choices in the given poll.
//
@@ -45,6 +45,14 @@ import (
// description: Target poll ID.
// in: path
// required: true
+// -
+// name: choices
+// type: array
+// items:
+// type: integer
+// description: Poll choice indices on which to vote.
+// in: formData
+// required: true
//
// security:
// - OAuth2 Bearer:
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.
diff --git a/internal/api/model/status.go b/internal/api/model/status.go
index 87db77e67..a6c7f43a4 100644
--- a/internal/api/model/status.go
+++ b/internal/api/model/status.go
@@ -155,7 +155,7 @@ type StatusCreateRequest struct {
// in: formData
MediaIDs []string `form:"media_ids[]" json:"media_ids" xml:"media_ids"`
// Poll to include with this status.
- // swagger:ignore
+ // in: formData
Poll *PollRequest `form:"poll" json:"poll" xml:"poll"`
// ID of the status being replied to, if status is a reply.
// in: formData