mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-27 06:06:38 +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>
81 lines
3.1 KiB
Go
81 lines
3.1 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
|
|
|
|
import "mime/multipart"
|
|
|
|
// Emoji represents a custom emoji.
|
|
//
|
|
// swagger:model emoji
|
|
type Emoji struct {
|
|
// The name of the custom emoji.
|
|
// example: blobcat_uwu
|
|
Shortcode string `json:"shortcode"`
|
|
// Web URL of the custom emoji.
|
|
// example: https://example.org/fileserver/emojis/blogcat_uwu.gif
|
|
URL string `json:"url"`
|
|
// A link to a static copy of the custom emoji.
|
|
// example: https://example.org/fileserver/emojis/blogcat_uwu.png
|
|
StaticURL string `json:"static_url"`
|
|
// Emoji is visible in the emoji picker of the instance.
|
|
// example: true
|
|
VisibleInPicker bool `json:"visible_in_picker"`
|
|
// Used for sorting custom emoji in the picker.
|
|
// example: blobcats
|
|
Category string `json:"category,omitempty"`
|
|
}
|
|
|
|
// EmojiCreateRequest represents a request to create a custom emoji made through the admin API.
|
|
//
|
|
// swagger:ignore
|
|
type EmojiCreateRequest struct {
|
|
// Desired shortcode for the emoji, without surrounding colons. This must be unique for the domain.
|
|
// example: blobcat_uwu
|
|
Shortcode string `form:"shortcode" validation:"required"`
|
|
// Image file to use for the emoji. Must be png or gif and no larger than 50kb.
|
|
Image *multipart.FileHeader `form:"image" validation:"required"`
|
|
// Category in which to place the new emoji. Will be uncategorized by default.
|
|
// CategoryName length should not exceed 64 characters.
|
|
CategoryName string `form:"category"`
|
|
}
|
|
|
|
// EmojiUpdateRequest represents a request to update a custom emoji, made through the admin API.
|
|
//
|
|
// swagger:ignore
|
|
type EmojiUpdateRequest struct {
|
|
// Type of action. One of disable, modify, copy.
|
|
Type EmojiUpdateType `form:"type" json:"type" xml:"type"`
|
|
// Desired shortcode for the emoji, without surrounding colons. This must be unique for the domain.
|
|
// example: blobcat_uwu
|
|
Shortcode *string `form:"shortcode"`
|
|
// Image file to use for the emoji.
|
|
// Must be png or gif and no larger than 50kb.
|
|
Image *multipart.FileHeader `form:"image"`
|
|
// Category in which to place the emoji.
|
|
CategoryName *string `form:"category"`
|
|
}
|
|
|
|
// EmojiUpdateType models an admin update action to take on a custom emoji.
|
|
type EmojiUpdateType string
|
|
|
|
const (
|
|
EmojiUpdateModify EmojiUpdateType = "modify" // modify local emoji
|
|
EmojiUpdateDisable EmojiUpdateType = "disable" // disable remote emoji
|
|
EmojiUpdateCopy EmojiUpdateType = "copy" // copy remote emoji -> local
|
|
)
|