mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-24 04:36: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>
63 lines
2.6 KiB
Go
63 lines
2.6 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
|
|
|
|
// Announcement models an admin announcement for the instance.
|
|
//
|
|
// TODO: swagger:model announcement once announcement API is supported
|
|
type Announcement struct {
|
|
// The ID of the announcement.
|
|
// example: 01FC30T7X4TNCZK0TH90QYF3M4
|
|
ID string `json:"id"`
|
|
// The body of the announcement.
|
|
// Should be HTML formatted.
|
|
// example: <p>This is an announcement. No malarky.</p>
|
|
Content string `json:"content"`
|
|
// When the announcement should begin to be displayed (ISO 8601 Datetime).
|
|
// If the announcement has no start time, this will be omitted or empty.
|
|
// example: 2021-07-30T09:20:25+00:00
|
|
StartsAt string `json:"starts_at"`
|
|
// When the announcement should stop being displayed (ISO 8601 Datetime).
|
|
// If the announcement has no end time, this will be omitted or empty.
|
|
// example: 2021-07-30T09:20:25+00:00
|
|
EndsAt string `json:"ends_at"`
|
|
// Announcement doesn't have begin time and end time, but begin day and end day.
|
|
AllDay bool `json:"all_day"`
|
|
// When the announcement was first published (ISO 8601 Datetime).
|
|
// example: 2021-07-30T09:20:25+00:00
|
|
PublishedAt string `json:"published_at"`
|
|
// When the announcement was last updated (ISO 8601 Datetime).
|
|
// example: 2021-07-30T09:20:25+00:00
|
|
UpdatedAt string `json:"updated_at"`
|
|
// Announcement is 'published', ie., visible to users.
|
|
// Announcements that are not published should be shown only to admins.
|
|
Published bool `json:"published"`
|
|
// Requesting account has seen this announcement.
|
|
Read bool `json:"read"`
|
|
// Mentions this announcement contains.
|
|
Mentions []Mention `json:"mentions"`
|
|
// Statuses contained in this announcement.
|
|
Statuses []Status `json:"statuses"`
|
|
// Tags used in this announcement.
|
|
Tags []Tag `json:"tags"`
|
|
// Emojis used in this announcement.
|
|
Emojis []Emoji `json:"emoji"`
|
|
// Reactions to this announcement.
|
|
Reactions []AnnouncementReaction `json:"reactions"`
|
|
}
|