mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2024-11-23 21:03:19 +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>
96 lines
4.2 KiB
Go
96 lines
4.2 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"
|
|
|
|
// Domain represents a remote domain
|
|
//
|
|
// swagger:model domain
|
|
type Domain struct {
|
|
// The hostname of the domain.
|
|
// example: example.org
|
|
Domain string `form:"domain" json:"domain" validate:"required"`
|
|
// Time at which this domain was suspended. Key will not be present on open domains.
|
|
// example: 2021-07-30T09:20:25+00:00
|
|
SuspendedAt string `json:"suspended_at,omitempty"`
|
|
// Time at which this domain was silenced. Key will not be present on open domains.
|
|
// example: 2021-07-30T09:20:25+00:00
|
|
SilencedAt string `json:"silenced_at,omitempty"`
|
|
// If the domain is blocked, what's the publicly-stated reason for the block.
|
|
// example: they smell
|
|
PublicComment string `form:"public_comment" json:"public_comment,omitempty"`
|
|
}
|
|
|
|
// DomainPermission represents a permission applied to one domain (explicit block/allow).
|
|
//
|
|
// swagger:model domainPermission
|
|
type DomainPermission struct {
|
|
Domain
|
|
// The ID of the domain permission entry.
|
|
// example: 01FBW21XJA09XYX51KV5JVBW0F
|
|
// readonly: true
|
|
ID string `json:"id,omitempty"`
|
|
// Obfuscate the domain name when serving this domain permission entry publicly.
|
|
// example: false
|
|
Obfuscate bool `json:"obfuscate,omitempty"`
|
|
// Private comment for this permission entry, visible to this instance's admins only.
|
|
// example: they are poopoo
|
|
PrivateComment string `json:"private_comment,omitempty"`
|
|
// If applicable, the ID of the subscription that caused this domain permission entry to be created.
|
|
// example: 01FBW25TF5J67JW3HFHZCSD23K
|
|
SubscriptionID string `json:"subscription_id,omitempty"`
|
|
// ID of the account that created this domain permission entry.
|
|
// example: 01FBW2758ZB6PBR200YPDDJK4C
|
|
CreatedBy string `json:"created_by,omitempty"`
|
|
// Time at which the permission entry was created (ISO 8601 Datetime).
|
|
// example: 2021-07-30T09:20:25+00:00
|
|
CreatedAt string `json:"created_at,omitempty"`
|
|
}
|
|
|
|
// DomainPermissionRequest is the form submitted as a POST to create a new domain permission entry (allow/block).
|
|
//
|
|
// swagger:ignore
|
|
type DomainPermissionRequest struct {
|
|
// A list of domains for which this permission request should apply.
|
|
// Only used if import=true is specified.
|
|
Domains *multipart.FileHeader `form:"domains" json:"domains" xml:"domains"`
|
|
// A single domain for which this permission request should apply.
|
|
// Only used if import=true is NOT specified or if import=false.
|
|
// example: example.org
|
|
Domain string `form:"domain" json:"domain" xml:"domain"`
|
|
// Obfuscate the domain name when displaying this permission entry publicly.
|
|
// Ie., instead of 'example.org' show something like 'e**mpl*.or*'.
|
|
// example: false
|
|
Obfuscate bool `form:"obfuscate" json:"obfuscate" xml:"obfuscate"`
|
|
// Private comment for other admins on why this permission entry was created.
|
|
// example: don't like 'em!!!!
|
|
PrivateComment string `form:"private_comment" json:"private_comment" xml:"private_comment"`
|
|
// Public comment on why this permission entry was created.
|
|
// Will be visible to requesters at /api/v1/instance/peers if this endpoint is exposed.
|
|
// example: foss dorks 😫
|
|
PublicComment string `form:"public_comment" json:"public_comment" xml:"public_comment"`
|
|
}
|
|
|
|
// DomainKeysExpireRequest is the form submitted as a POST to /api/v1/admin/domain_keys_expire to expire a domain's public keys.
|
|
//
|
|
// swagger:parameters domainKeysExpire
|
|
type DomainKeysExpireRequest struct {
|
|
// hostname/domain to expire keys for.
|
|
Domain string `form:"domain" json:"domain" xml:"domain"`
|
|
}
|