mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-31 03:42:25 -05:00
58dddd86e0* start experimenting with swagger documentation * further adventures in swagger * do a few more api paths * account paths documented * go fmt * fix up some models * bit o lintin'
116 lines
4.9 KiB
Go
116 lines
4.9 KiB
Go
/*
|
|
GoToSocial
|
|
Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
|
|
|
|
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"
|
|
|
|
// AttachmentRequest represents the form data parameters submitted by a client during a media upload request.
|
|
// See: https://docs.joinmastodon.org/methods/statuses/media/
|
|
type AttachmentRequest struct {
|
|
File *multipart.FileHeader `form:"file" binding:"required"`
|
|
Description string `form:"description"`
|
|
Focus string `form:"focus"`
|
|
}
|
|
|
|
// AttachmentUpdateRequest represents the form data parameters submitted by a client during a media update/PUT request.
|
|
// See: https://docs.joinmastodon.org/methods/statuses/media/
|
|
type AttachmentUpdateRequest struct {
|
|
Description *string `form:"description" json:"description" xml:"description"`
|
|
Focus *string `form:"focus" json:"focus" xml:"focus"`
|
|
}
|
|
|
|
// Attachment represents the object returned to a client after a successful media upload request.
|
|
//
|
|
// swagger:model attachment
|
|
type Attachment struct {
|
|
// The ID of the attachment.
|
|
ID string `json:"id"`
|
|
// The type of the attachment.
|
|
// unknown = unsupported or unrecognized file type.
|
|
// image = Static image.
|
|
// gifv = Looping, soundless animation.
|
|
// video = Video clip.
|
|
// audio = Audio track.
|
|
// example: image
|
|
Type string `json:"type"`
|
|
// The location of the original full-size attachment.
|
|
// example: https://example.org/fileserver/some_id/attachments/some_id/original/attachment.jpeg
|
|
URL string `json:"url"`
|
|
// The location of a scaled-down preview of the attachment.
|
|
// example: https://example.org/fileserver/some_id/attachments/some_id/small/attachment.jpeg
|
|
PreviewURL string `json:"preview_url"`
|
|
// The location of the full-size original attachment on the remote server.
|
|
// Only defined for instances other than our own.
|
|
// example: https://some-other-server.org/attachments/original/ahhhhh.jpeg
|
|
RemoteURL string `json:"remote_url,omitempty"`
|
|
// The location of a scaled-down preview of the attachment on the remote server.
|
|
// Only defined for instances other than our own.
|
|
// example: https://some-other-server.org/attachments/small/ahhhhh.jpeg
|
|
PreviewRemoteURL string `json:"preview_remote_url,omitempty"`
|
|
// A shorter URL for the attachment.
|
|
TextURL string `json:"text_url,omitempty"`
|
|
// Metadata for this attachment.
|
|
Meta MediaMeta `json:"meta,omitempty"`
|
|
// Alt text that describes what is in the media attachment.
|
|
// example: This is a picture of a kitten.
|
|
Description string `json:"description,omitempty"`
|
|
// A hash computed by the BlurHash algorithm, for generating colorful preview thumbnails when media has not been downloaded yet.
|
|
// See https://github.com/woltapp/blurhash
|
|
Blurhash string `json:"blurhash,omitempty"`
|
|
}
|
|
|
|
// MediaMeta describes the returned media
|
|
//
|
|
// swagger:model mediaMeta
|
|
type MediaMeta struct {
|
|
Length string `json:"length,omitempty"`
|
|
Duration float32 `json:"duration,omitempty"`
|
|
FPS uint16 `json:"fps,omitempty"`
|
|
Size string `json:"size,omitempty"`
|
|
Width int `json:"width,omitempty"`
|
|
Height int `json:"height,omitempty"`
|
|
Aspect float32 `json:"aspect,omitempty"`
|
|
AudioEncode string `json:"audio_encode,omitempty"`
|
|
AudioBitrate string `json:"audio_bitrate,omitempty"`
|
|
AudioChannels string `json:"audio_channels,omitempty"`
|
|
Original MediaDimensions `json:"original"`
|
|
Small MediaDimensions `json:"small,omitempty"`
|
|
Focus MediaFocus `json:"focus,omitempty"`
|
|
}
|
|
|
|
// MediaFocus describes the focal point of a piece of media. It should be returned to the caller as part of MediaMeta.
|
|
//
|
|
// swagger:model mediaFocus
|
|
type MediaFocus struct {
|
|
X float32 `json:"x"` // should be between -1 and 1
|
|
Y float32 `json:"y"` // should be between -1 and 1
|
|
}
|
|
|
|
// MediaDimensions describes the physical properties of a piece of media. It should be returned to the caller as part of MediaMeta.
|
|
//
|
|
// swagger:model mediaDimensions
|
|
type MediaDimensions struct {
|
|
Width int `json:"width,omitempty"`
|
|
Height int `json:"height,omitempty"`
|
|
FrameRate string `json:"frame_rate,omitempty"`
|
|
Duration float32 `json:"duration,omitempty"`
|
|
Bitrate int `json:"bitrate,omitempty"`
|
|
Size string `json:"size,omitempty"`
|
|
Aspect float32 `json:"aspect,omitempty"`
|
|
}
|