diff options
Diffstat (limited to 'internal/api/client/admin')
-rw-r--r-- | internal/api/client/admin/domainblockcreate.go | 24 | ||||
-rw-r--r-- | internal/api/client/admin/domainblockdelete.go | 4 | ||||
-rw-r--r-- | internal/api/client/admin/domainblockget.go | 4 | ||||
-rw-r--r-- | internal/api/client/admin/domainblocksget.go | 4 | ||||
-rw-r--r-- | internal/api/client/admin/emojicreate.go | 9 |
5 files changed, 16 insertions, 29 deletions
diff --git a/internal/api/client/admin/domainblockcreate.go b/internal/api/client/admin/domainblockcreate.go index 8b9071c7c..d48c70408 100644 --- a/internal/api/client/admin/domainblockcreate.go +++ b/internal/api/client/admin/domainblockcreate.go @@ -12,13 +12,11 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/oauth" ) -// DomainBlocksPOSTHandler deals with the creation of one or more domain blocks. -// -// swagger:operation PATCH /api/v1/admin/domain_blocks domainBlockCreate +// DomainBlocksPOSTHandler swagger:operation POST /api/v1/admin/domain_blocks domainBlockCreate // // Create one or more domain blocks, from a string or a file. // -// Note that you have two options when using this endpoint: either you can set 'import' to true +// Note that you have two options when using this endpoint: either you can set `import` to true // and upload a file containing multiple domain blocks, JSON-formatted, or you can leave import as // false, and just add one domain block. // @@ -46,38 +44,35 @@ import ( // in: formData // description: |- // JSON-formatted list of domain blocks to import. -// This is only used if 'import' is set to true. +// This is only used if `import` is set to true. // type: file // - name: domain // in: formData // description: |- // Single domain to block. -// Used only if 'import' is not true. +// Used only if `import` is not true. // type: string -// example: example.org // - name: obfuscate // in: formData // description: |- // Obfuscate the name of the domain when serving it publicly. // Eg., 'example.org' becomes something like 'ex***e.org'. -// Used only if 'import' is not true. +// Used only if `import` is not true. // type: boolean // - name: public_comment // in: formData // description: |- // Public comment about this domain block. // Will be displayed alongside the domain block if you choose to share blocks. -// Used only if 'import' is not true. +// Used only if `import` is not true. // type: string -// example: "harassment, transphobia" // - name: private_comment // in: formData // description: |- // Private comment about this domain block. Will only be shown to other admins, so this // is a useful way of internally keeping track of why a certain domain ended up blocked. -// Used only if 'import' is not true. +// Used only if `import` is not true. // type: string -// example: "harassment, transphobia, and some stuff only other admins need to know about" // // security: // - OAuth2 Bearer: @@ -86,9 +81,8 @@ import ( // responses: // '200': // description: |- -// The newly created domain block, if import != true. -// Note that if a list has been imported, then an `array` of -// newly created domain blocks will be returned instead. +// The newly created domain block, if `import` != `true`. +// Note that if a list has been imported, then an `array` of newly created domain blocks will be returned instead. // schema: // "$ref": "#/definitions/domainBlock" // '403': diff --git a/internal/api/client/admin/domainblockdelete.go b/internal/api/client/admin/domainblockdelete.go index 8b773a5a9..9cd2fd711 100644 --- a/internal/api/client/admin/domainblockdelete.go +++ b/internal/api/client/admin/domainblockdelete.go @@ -8,9 +8,7 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/oauth" ) -// DomainBlockDELETEHandler deals with the delete of an existing domain block. -// -// swagger:operation DELETE /api/v1/admin/domain_blocks/{id} domainBlockDelete +// DomainBlockDELETEHandler swagger:operation DELETE /api/v1/admin/domain_blocks/{id} domainBlockDelete // // Delete domain block with the given ID. // diff --git a/internal/api/client/admin/domainblockget.go b/internal/api/client/admin/domainblockget.go index 5fd48ba23..86923d705 100644 --- a/internal/api/client/admin/domainblockget.go +++ b/internal/api/client/admin/domainblockget.go @@ -9,9 +9,7 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/oauth" ) -// DomainBlockGETHandler returns one existing domain block, identified by its id. -// -// swagger:operation GET /api/v1/admin/domain_blocks/{id} domainBlockGet +// DomainBlockGETHandler swagger:operation GET /api/v1/admin/domain_blocks/{id} domainBlockGet // // View domain block with the given ID. // diff --git a/internal/api/client/admin/domainblocksget.go b/internal/api/client/admin/domainblocksget.go index 70f1f5d08..77a287387 100644 --- a/internal/api/client/admin/domainblocksget.go +++ b/internal/api/client/admin/domainblocksget.go @@ -9,9 +9,7 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/oauth" ) -// DomainBlocksGETHandler returns a list of all existing domain blocks. -// -// swagger:operation GET /api/v1/admin/domain_blocks domainBlocksGet +// DomainBlocksGETHandler swagger:operation GET /api/v1/admin/domain_blocks domainBlocksGet // // View all domain blocks currently in place. // diff --git a/internal/api/client/admin/emojicreate.go b/internal/api/client/admin/emojicreate.go index 94e6ecf7a..bfdf28249 100644 --- a/internal/api/client/admin/emojicreate.go +++ b/internal/api/client/admin/emojicreate.go @@ -31,9 +31,7 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/util" ) -// emojiCreateRequest handles the creation of a new instance emoji. -// -// swagger:operation POST /api/v1/admin/custom_emojis emojiCreate +// emojiCreateRequest swagger:operation POST /api/v1/admin/custom_emojis emojiCreate // // Upload and create a new instance emoji. // @@ -55,11 +53,12 @@ import ( // This must be unique on the instance. // type: string // pattern: \w{2,30} -// example: blobcat_uwu -// - name: domains +// required: true +// - name: image // in: formData // description: A png or gif image of the emoji. Animated pngs work too! // type: file +// required: true // // security: // - OAuth2 Bearer: |