mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-11-03 19:32:26 -06: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>
80 lines
3.2 KiB
Go
80 lines
3.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 users
|
|
|
|
// SwaggerCollection represents an ActivityPub Collection.
|
|
// swagger:model swaggerCollection
|
|
type SwaggerCollection struct {
|
|
// ActivityStreams JSON-LD context.
|
|
// A string or an array of strings, or more
|
|
// complex nested items.
|
|
// example: https://www.w3.org/ns/activitystreams
|
|
Context interface{} `json:"@context"`
|
|
// ActivityStreams ID.
|
|
// example: https://example.org/users/some_user/statuses/106717595988259568/replies
|
|
ID string `json:"id"`
|
|
// ActivityStreams type.
|
|
// example: Collection
|
|
Type string `json:"type"`
|
|
// ActivityStreams first property.
|
|
First SwaggerCollectionPage `json:"first"`
|
|
// ActivityStreams last property.
|
|
Last SwaggerCollectionPage `json:"last,omitempty"`
|
|
}
|
|
|
|
// SwaggerCollectionPage represents one page of a collection.
|
|
// swagger:model swaggerCollectionPage
|
|
type SwaggerCollectionPage struct {
|
|
// ActivityStreams ID.
|
|
// example: https://example.org/users/some_user/statuses/106717595988259568/replies?page=true
|
|
ID string `json:"id"`
|
|
// ActivityStreams type.
|
|
// example: CollectionPage
|
|
Type string `json:"type"`
|
|
// Link to the next page.
|
|
// example: https://example.org/users/some_user/statuses/106717595988259568/replies?only_other_accounts=true&page=true
|
|
Next string `json:"next"`
|
|
// Collection this page belongs to.
|
|
// example: https://example.org/users/some_user/statuses/106717595988259568/replies
|
|
PartOf string `json:"partOf"`
|
|
// Items on this page.
|
|
// example: ["https://example.org/users/some_other_user/statuses/086417595981111564", "https://another.example.com/users/another_user/statuses/01FCN8XDV3YG7B4R42QA6YQZ9R"]
|
|
Items []string `json:"items"`
|
|
}
|
|
|
|
// SwaggerFeaturedCollection represents an ActivityPub OrderedCollection.
|
|
// swagger:model swaggerFeaturedCollection
|
|
type SwaggerFeaturedCollection struct {
|
|
// ActivityStreams JSON-LD context.
|
|
// A string or an array of strings, or more
|
|
// complex nested items.
|
|
// example: https://www.w3.org/ns/activitystreams
|
|
Context interface{} `json:"@context"`
|
|
// ActivityStreams ID.
|
|
// example: https://example.org/users/some_user/collections/featured
|
|
ID string `json:"id"`
|
|
// ActivityStreams type.
|
|
// example: OrderedCollection
|
|
Type string `json:"type"`
|
|
// List of status URIs.
|
|
// example: ["https://example.org/users/some_user/statuses/01GSZ0F7Q8SJKNRF777GJD271R", "https://example.org/users/some_user/statuses/01GSZ0G012CBQ7TEKX689S3QRE"]
|
|
Items []string `json:"items"`
|
|
// Number of items in this collection.
|
|
// example: 2
|
|
TotalItems int
|
|
}
|