list.go (2473B)
1 // GoToSocial 2 // Copyright (C) GoToSocial Authors admin@gotosocial.org 3 // SPDX-License-Identifier: AGPL-3.0-or-later 4 // 5 // This program is free software: you can redistribute it and/or modify 6 // it under the terms of the GNU Affero General Public License as published by 7 // the Free Software Foundation, either version 3 of the License, or 8 // (at your option) any later version. 9 // 10 // This program is distributed in the hope that it will be useful, 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 // GNU Affero General Public License for more details. 14 // 15 // You should have received a copy of the GNU Affero General Public License 16 // along with this program. If not, see <http://www.gnu.org/licenses/>. 17 18 package model 19 20 // List represents a user-created list of accounts that the user follows. 21 // 22 // swagger:model list 23 type List struct { 24 // The ID of the list. 25 ID string `json:"id"` 26 // The user-defined title of the list. 27 Title string `json:"title"` 28 // RepliesPolicy for this list. 29 // followed = Show replies to any followed user 30 // list = Show replies to members of the list 31 // none = Show replies to no one 32 RepliesPolicy string `json:"replies_policy"` 33 } 34 35 // ListCreateRequest models list creation parameters. 36 // 37 // swagger:parameters listCreate 38 type ListCreateRequest struct { 39 // Title of this list. 40 // example: Cool People 41 // in: formData 42 // required: true 43 Title string `form:"title" json:"title" xml:"title"` 44 // RepliesPolicy for this list. 45 // followed = Show replies to any followed user 46 // list = Show replies to members of the list 47 // none = Show replies to no one 48 // example: list 49 // default: list 50 // in: formData 51 RepliesPolicy string `form:"replies_policy" json:"replies_policy" xml:"replies_policy"` 52 } 53 54 // ListUpdateRequest models list update parameters. 55 // 56 // swagger:parameters listUpdate 57 type ListUpdateRequest struct { 58 // Title of this list. 59 // example: Cool People 60 // in: formData 61 Title *string `form:"title" json:"title" xml:"title"` 62 // RepliesPolicy for this list. 63 // followed = Show replies to any followed user 64 // list = Show replies to members of the list 65 // none = Show replies to no one 66 // in: formData 67 RepliesPolicy *string `form:"replies_policy" json:"replies_policy" xml:"replies_policy"` 68 } 69 70 // swagger:ignore 71 type ListAccountsChangeRequest struct { 72 AccountIDs []string `form:"account_ids[]" json:"account_ids" xml:"account_ids"` 73 }