mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-13 04:51:13 +00:00
fc3741365c
* Add Swagger spec test script * Fix Swagger spec errors not related to statuses with polls * Add API tests that post a status with a poll * Fix creating a status with a poll from form params * Fix Swagger spec errors related to statuses with polls (this is the last error) * Fix Swagger spec warnings not related to unused definitions * Suppress a duplicate list update params definition that was somehow causing wrong param names * Add Swagger test to CI - updates Drone config - vendorizes go-swagger - fixes a file extension issue that caused the test script to generate JSON instead of YAML with the vendorized version * Put `Sample: ` on its own line everywhere * Remove unused id param from emojiCategoriesGet * Add 5 more pairs of profile fields to account update API Swagger * Remove Swagger prefix from dummy fields It makes the generated code look weird * Manually annotate params for statusCreate operation * Fix all remaining Swagger spec warnings - Change some models into operation parameters - Ignore models that already correspond to manually documented operation parameters but can't be trivially changed (those with file fields) * Documented that creating a status with scheduled_at isn't implemented yet * sign drone.yml * Fix filter API Swagger errors * fixup! Fix filter API Swagger errors --------- Co-authored-by: tobi <tobi.smethurst@protonmail.com>
80 lines
2.5 KiB
Go
80 lines
2.5 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package model
|
|
|
|
// List represents a user-created list of accounts that the user follows.
|
|
//
|
|
// swagger:model list
|
|
type List struct {
|
|
// The ID of the list.
|
|
ID string `json:"id"`
|
|
// The user-defined title of the list.
|
|
Title string `json:"title"`
|
|
// RepliesPolicy for this list.
|
|
// followed = Show replies to any followed user
|
|
// list = Show replies to members of the list
|
|
// none = Show replies to no one
|
|
RepliesPolicy string `json:"replies_policy"`
|
|
}
|
|
|
|
// ListCreateRequest models list creation parameters.
|
|
//
|
|
// swagger:parameters listCreate
|
|
type ListCreateRequest struct {
|
|
// Title of this list.
|
|
// Sample: Cool People
|
|
// in: formData
|
|
// required: true
|
|
Title string `form:"title" json:"title" xml:"title"`
|
|
// RepliesPolicy for this list.
|
|
// followed = Show replies to any followed user
|
|
// list = Show replies to members of the list
|
|
// none = Show replies to no one
|
|
// Sample: list
|
|
// default: list
|
|
// in: formData
|
|
// enum:
|
|
// - followed
|
|
// - list
|
|
// - none
|
|
RepliesPolicy string `form:"replies_policy" json:"replies_policy" xml:"replies_policy"`
|
|
}
|
|
|
|
// ListUpdateRequest models list update parameters.
|
|
//
|
|
// swagger:ignore
|
|
type ListUpdateRequest struct {
|
|
// Title of this list.
|
|
// Sample: Cool People
|
|
// in: formData
|
|
Title *string `form:"title" json:"title" xml:"title"`
|
|
// RepliesPolicy for this list.
|
|
// followed = Show replies to any followed user
|
|
// list = Show replies to members of the list
|
|
// none = Show replies to no one
|
|
// Sample: list
|
|
// in: formData
|
|
RepliesPolicy *string `form:"replies_policy" json:"replies_policy" xml:"replies_policy"`
|
|
}
|
|
|
|
// ListAccountsChangeRequest is a list of account IDs to add to or remove from a list.
|
|
//
|
|
// swagger:ignore
|
|
type ListAccountsChangeRequest struct {
|
|
AccountIDs []string `form:"account_ids[]" json:"account_ids" xml:"account_ids"`
|
|
}
|