diff options
Diffstat (limited to 'internal/api/client/admin')
| -rw-r--r-- | internal/api/client/admin/accountaction.go | 84 | ||||
| -rw-r--r-- | internal/api/client/admin/domainblockcreate.go | 153 | ||||
| -rw-r--r-- | internal/api/client/admin/domainblockdelete.go | 63 | ||||
| -rw-r--r-- | internal/api/client/admin/domainblockget.go | 63 | ||||
| -rw-r--r-- | internal/api/client/admin/domainblocksget.go | 75 | ||||
| -rw-r--r-- | internal/api/client/admin/emojicreate.go | 92 | ||||
| -rw-r--r-- | internal/api/client/admin/mediacleanup.go | 57 |
7 files changed, 301 insertions, 286 deletions
diff --git a/internal/api/client/admin/accountaction.go b/internal/api/client/admin/accountaction.go index a9817f295..2dc84a2d0 100644 --- a/internal/api/client/admin/accountaction.go +++ b/internal/api/client/admin/accountaction.go @@ -34,52 +34,54 @@ import ( // // Perform an admin action on an account. // -// --- -// tags: -// - admin +// --- +// tags: +// - admin // -// consumes: -// - multipart/form-data +// consumes: +// - multipart/form-data // -// produces: -// - application/json +// produces: +// - application/json // -// parameters: -// - name: id -// required: true -// in: path -// description: ID of the account. -// type: string -// - name: type -// in: formData -// description: |- -// Type of action to be taken. One of: disable, silence, suspend. -// type: string -// required: true -// - name: text -// in: formData -// description: Optional text describing why this action was taken. -// type: string +// parameters: +// - +// name: id +// required: true +// in: path +// description: ID of the account. +// type: string +// - +// name: type +// in: formData +// description: Type of action to be taken (`disable`, `silence`, or `suspend`). +// type: string +// required: true +// - +// name: text +// in: formData +// description: Optional text describing why this action was taken. +// type: string // -// security: -// - OAuth2 Bearer: -// - admin +// security: +// - OAuth2 Bearer: +// - admin // -// responses: -// '200': -// description: OK -// '400': -// description: bad request -// '401': -// description: unauthorized -// '403': -// description: forbidden -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error +// responses: +// '200': +// description: OK +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) AccountActionPOSTHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { diff --git a/internal/api/client/admin/domainblockcreate.go b/internal/api/client/admin/domainblockcreate.go index 9ee725bef..034ea8682 100644 --- a/internal/api/client/admin/domainblockcreate.go +++ b/internal/api/client/admin/domainblockcreate.go @@ -35,87 +35,94 @@ import ( // // 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 -// and upload a file containing multiple domain blocks, JSON-formatted, or you can leave import as -// false, and just add one domain block. +// 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. // // The format of the json file should be something like: `[{"domain":"example.org"},{"domain":"whatever.com","public_comment":"they smell"}]` // -// --- -// tags: -// - admin +// --- +// tags: +// - admin // -// consumes: -// - multipart/form-data +// consumes: +// - multipart/form-data // -// produces: -// - application/json +// produces: +// - application/json // -// parameters: -// - name: import -// in: query -// description: |- -// Signal that a list of domain blocks is being imported as a file. -// If set to true, then 'domains' must be present as a JSON-formatted file. -// If set to false, then 'domains' will be ignored, and 'domain' must be present. -// type: boolean -// - name: domains -// in: formData -// description: |- -// JSON-formatted list of domain blocks to import. -// 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. -// type: string -// - 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. -// 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. -// type: string -// - 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. -// type: string +// parameters: +// - +// name: import +// in: query +// description: >- +// Signal that a list of domain blocks is being imported as a file. +// If set to `true`, then 'domains' must be present as a JSON-formatted file. +// If set to `false`, then `domains` will be ignored, and `domain` must be present. +// type: boolean +// default: false +// - +// name: domains +// in: formData +// description: >- +// JSON-formatted list of domain blocks to import. +// 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`. +// type: string +// - +// 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`. +// type: boolean +// - +// name: public_comment +// in: formData +// description: >- +// Public comment about this domain block. +// This will be displayed alongside the domain block if you choose to share blocks. +// Used only if `import` is not `true`. +// type: string +// - +// 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`. +// type: string // -// security: -// - OAuth2 Bearer: -// - admin +// security: +// - OAuth2 Bearer: +// - admin // -// 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. -// schema: -// "$ref": "#/definitions/domainBlock" -// '400': -// description: bad request -// '401': -// description: unauthorized -// '403': -// description: forbidden -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error +// responses: +// '200': +// description: >- +// The newly created domain block, if `import` != `true`. +// If a list has been imported, then an `array` of newly created domain blocks will be returned instead. +// schema: +// "$ref": "#/definitions/domainBlock" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) DomainBlocksPOSTHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { diff --git a/internal/api/client/admin/domainblockdelete.go b/internal/api/client/admin/domainblockdelete.go index aec1ba6df..6f3684418 100644 --- a/internal/api/client/admin/domainblockdelete.go +++ b/internal/api/client/admin/domainblockdelete.go @@ -33,41 +33,42 @@ import ( // // Delete domain block with the given ID. // -// --- -// tags: -// - admin +// --- +// tags: +// - admin // -// produces: -// - application/json +// produces: +// - application/json // -// parameters: -// - name: id -// type: string -// description: The id of the domain block. -// in: path -// required: true +// parameters: +// - +// name: id +// type: string +// description: The id of the domain block. +// in: path +// required: true // -// security: -// - OAuth2 Bearer: -// - admin +// security: +// - OAuth2 Bearer: +// - admin // -// responses: -// '200': -// description: The domain block that was just deleted. -// schema: -// "$ref": "#/definitions/domainBlock" -// '400': -// description: bad request -// '401': -// description: unauthorized -// '403': -// description: forbidden -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error +// responses: +// '200': +// description: The domain block that was just deleted. +// schema: +// "$ref": "#/definitions/domainBlock" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) DomainBlockDELETEHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { diff --git a/internal/api/client/admin/domainblockget.go b/internal/api/client/admin/domainblockget.go index 1aeedce51..3d27b585e 100644 --- a/internal/api/client/admin/domainblockget.go +++ b/internal/api/client/admin/domainblockget.go @@ -34,41 +34,42 @@ import ( // // View domain block with the given ID. // -// --- -// tags: -// - admin +// --- +// tags: +// - admin // -// produces: -// - application/json +// produces: +// - application/json // -// parameters: -// - name: id -// type: string -// description: The id of the domain block. -// in: path -// required: true +// parameters: +// - +// name: id +// type: string +// description: The id of the domain block. +// in: path +// required: true // -// security: -// - OAuth2 Bearer: -// - admin +// security: +// - OAuth2 Bearer: +// - admin // -// responses: -// '200': -// description: The requested domain block. -// schema: -// "$ref": "#/definitions/domainBlock" -// '400': -// description: bad request -// '401': -// description: unauthorized -// '403': -// description: forbidden -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error +// responses: +// '200': +// description: The requested domain block. +// schema: +// "$ref": "#/definitions/domainBlock" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) DomainBlockGETHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { diff --git a/internal/api/client/admin/domainblocksget.go b/internal/api/client/admin/domainblocksget.go index 93bd767c4..a4ab4ac1c 100644 --- a/internal/api/client/admin/domainblocksget.go +++ b/internal/api/client/admin/domainblocksget.go @@ -33,47 +33,48 @@ import ( // // View all domain blocks currently in place. // -// --- -// tags: -// - admin +// --- +// tags: +// - admin // -// produces: -// - application/json +// produces: +// - application/json // -// parameters: -// - name: export -// type: boolean -// description: |- -// If set to true, then each entry in the returned list of domain blocks will only consist of -// the fields 'domain' and 'public_comment'. This is perfect for when you want to save and share -// a list of all the domains you have blocked on your instance, so that someone else can easily import them, -// but you don't need them to see the database IDs of your blocks, or private comments etc. -// in: query -// required: false +// parameters: +// - +// name: export +// type: boolean +// description: >- +// If set to `true`, then each entry in the returned list of domain blocks will only consist of +// the fields `domain` and `public_comment`. This is perfect for when you want to save and share +// a list of all the domains you have blocked on your instance, so that someone else can easily import them, +// but you don't want them to see the database IDs of your blocks, or private comments etc. +// in: query +// required: false // -// security: -// - OAuth2 Bearer: -// - admin +// security: +// - OAuth2 Bearer: +// - admin // -// responses: -// '200': -// description: All domain blocks currently in place. -// schema: -// type: array -// items: -// "$ref": "#/definitions/domainBlock" -// '400': -// description: bad request -// '401': -// description: unauthorized -// '403': -// description: forbidden -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error +// responses: +// '200': +// description: All domain blocks currently in place. +// schema: +// type: array +// items: +// "$ref": "#/definitions/domainBlock" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) DomainBlocksGETHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { diff --git a/internal/api/client/admin/emojicreate.go b/internal/api/client/admin/emojicreate.go index eef49b2c7..b8dbfe43e 100644 --- a/internal/api/client/admin/emojicreate.go +++ b/internal/api/client/admin/emojicreate.go @@ -36,56 +36,58 @@ import ( // // Upload and create a new instance emoji. // -// --- -// tags: -// - admin +// --- +// tags: +// - admin // -// consumes: -// - multipart/form-data +// consumes: +// - multipart/form-data // -// produces: -// - application/json +// produces: +// - application/json // -// parameters: -// - name: shortcode -// in: formData -// description: |- -// The code to use for the emoji, which will be used by instance denizens to select it. -// This must be unique on the instance. -// type: string -// pattern: \w{2,30} -// required: true -// - name: image -// in: formData -// description: |- -// A png or gif image of the emoji. Animated pngs work too! -// To ensure compatibility with other fedi implementations, emoji size limit is 50kb by default. -// type: file -// required: true +// parameters: +// - +// name: shortcode +// in: formData +// description: >- +// The code to use for the emoji, which will be used by instance denizens to select it. +// This must be unique on the instance. +// type: string +// pattern: \w{2,30} +// required: true +// - +// name: image +// in: formData +// description: >- +// A png or gif image of the emoji. Animated pngs work too! +// To ensure compatibility with other fedi implementations, emoji size limit is 50kb by default. +// type: file +// required: true // -// security: -// - OAuth2 Bearer: -// - admin +// security: +// - OAuth2 Bearer: +// - admin // -// responses: -// '200': -// description: The newly-created emoji. -// schema: -// "$ref": "#/definitions/emoji" -// '400': -// description: bad request -// '401': -// description: unauthorized -// '403': -// description: forbidden -// '404': -// description: not found -// '406': -// description: not acceptable -// '409': -// description: conflict -- domain/shortcode combo for emoji already exists -// '500': -// description: internal server error +// responses: +// '200': +// description: The newly-created emoji. +// schema: +// "$ref": "#/definitions/emoji" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '409': +// description: conflict -- shortcode for this emoji is already in use +// '500': +// description: internal server error func (m *Module) EmojiCreatePOSTHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { diff --git a/internal/api/client/admin/mediacleanup.go b/internal/api/client/admin/mediacleanup.go index 44f0a1b52..157f35ab0 100644 --- a/internal/api/client/admin/mediacleanup.go +++ b/internal/api/client/admin/mediacleanup.go @@ -35,38 +35,39 @@ import ( // Clean up remote media older than the specified number of days. // Also cleans up unused headers + avatars from the media cache. // -// --- -// tags: -// - admin +// --- +// tags: +// - admin // -// consumes: -// - application/json -// - application/xml -// - application/x-www-form-urlencoded +// consumes: +// - application/json +// - application/xml +// - application/x-www-form-urlencoded // -// produces: -// - application/json +// produces: +// - application/json // -// security: -// - OAuth2 Bearer: -// - admin +// security: +// - OAuth2 Bearer: +// - admin // -// responses: -// '200': -// description: |- -// Echos the number of days requested. The cleanup is performed asynchronously after the request completes. -// '400': -// description: bad request -// '401': -// description: unauthorized -// '403': -// description: forbidden -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error +// responses: +// '200': +// description: >- +// Echos the number of days requested. +// The cleanup is performed asynchronously after the request completes. +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) MediaCleanupPOSTHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { |