donat-widget/internal/docs/swagger.yaml
2025-02-25 11:54:14 +05:00

385 lines
10 KiB
YAML

basePath: /api/donat-wiget
definitions:
donat-widget_internal_model.FilterSettingResponse:
properties:
enableLinks:
type: boolean
filteredWords:
items:
type: string
type: array
type: object
donat-widget_internal_model.InnerDonatePageResponse:
properties:
avatar:
type: string
backgroundImg:
type: string
description:
type: string
pageBackground:
type: string
textAfterDonat:
type: string
type: object
donat-widget_internal_model.ModerationResponse:
properties:
duration:
type: integer
enable:
type: boolean
type: object
donat-widget_internal_model.OuterDonatePageResponse:
properties:
description:
type: string
login:
type: string
online:
type: string
type: object
donat-widget_internal_model.UpdateDonatPage:
properties:
description:
type: string
pageBackground:
type: string
profileAvatar:
type: boolean
textAfterDonat:
type: string
type: object
donat-widget_internal_model.UpdateFilterSettings:
properties:
addWords:
items:
type: string
type: array
enableLinks:
type: boolean
removeWords:
items:
type: string
type: array
type: object
donat-widget_internal_model.UpdateModeration:
properties:
duration:
type: integer
enable:
type: boolean
type: object
donat-widget_internal_model.UpdateVoiceSettings:
properties:
enable:
type: boolean
minPrice:
type: integer
scenery:
type: string
voiceSoundPercent:
type: integer
voiceSpeed:
type: integer
type: object
donat-widget_internal_model.VoiceSettingsResponse:
properties:
minPrice:
type: integer
scenery:
type: string
voiceSoundPercent:
type: integer
voiceSpeed:
type: integer
type: object
echo.HTTPError:
properties:
message: {}
type: object
info:
contact: {}
description: Donate auth service docs.
title: Donate Auth Documentation
version: "3.0"
paths:
/donat-page:
patch:
consumes:
- application/json
description: Update personal streamer donate page.
parameters:
- description: Update fields
in: body
name: request
required: true
schema:
$ref: '#/definitions/donat-widget_internal_model.UpdateDonatPage'
- description: Background image
in: formData
name: background
type: file
produces:
- application/json
responses:
"200":
description: Donat page updated successfully
schema:
type: string
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Update personal streamer donate page.
tags:
- Donate
/filters-settings:
get:
consumes:
- application/json
description: Get donat filters settings
produces:
- application/json
responses:
"200":
description: Current filters settings
schema:
$ref: '#/definitions/donat-widget_internal_model.FilterSettingResponse'
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Get donat filters settings
tags:
- Donate
patch:
consumes:
- application/json
description: Update donat filters settings.
parameters:
- description: Update fields
in: body
name: request
required: true
schema:
$ref: '#/definitions/donat-widget_internal_model.UpdateFilterSettings'
- description: Background image
in: formData
name: background
type: file
produces:
- application/json
responses:
"200":
description: Voice settings updated successfully
schema:
type: string
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Update donat filters settings.
tags:
- Donate
/inner-donate-page:
get:
consumes:
- application/json
description: Get inner donate page info
produces:
- application/json
responses:
"200":
description: Current donate page state
schema:
$ref: '#/definitions/donat-widget_internal_model.InnerDonatePageResponse'
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Get inner donate page info
tags:
- Donate
/moderation-settings:
get:
consumes:
- application/json
description: Get donat moderation settings
produces:
- application/json
responses:
"200":
description: Current moderation settings
schema:
$ref: '#/definitions/donat-widget_internal_model.ModerationResponse'
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Get donat moderation settings
tags:
- Donate
patch:
consumes:
- application/json
description: Update donat moderation settings
produces:
- application/json
responses:
"200":
description: Update moderation settings
schema:
$ref: '#/definitions/donat-widget_internal_model.UpdateModeration'
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Update donat moderation settings
tags:
- Donate
/outer-donate-page:
get:
consumes:
- application/json
description: Get outer donate page info
produces:
- application/json
responses:
"200":
description: Current donate page state
schema:
$ref: '#/definitions/donat-widget_internal_model.OuterDonatePageResponse'
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Get outer donate page info
tags:
- Donate
/voice-settings:
get:
consumes:
- application/json
description: Get donat voice settings
produces:
- application/json
responses:
"200":
description: Current voice settings
schema:
$ref: '#/definitions/donat-widget_internal_model.VoiceSettingsResponse'
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Get donat voice settings
tags:
- Donate
patch:
consumes:
- application/json
description: Update donat voice settings.
parameters:
- description: Update fields
in: body
name: request
required: true
schema:
$ref: '#/definitions/donat-widget_internal_model.UpdateVoiceSettings'
- description: Background image
in: formData
name: background
type: file
produces:
- application/json
responses:
"200":
description: Voice settings updated successfully
schema:
type: string
"400":
description: Bad request
schema:
$ref: '#/definitions/echo.HTTPError'
"401":
description: Unauthorized or expired token
schema:
$ref: '#/definitions/echo.HTTPError'
"422":
description: Validation error
schema:
$ref: '#/definitions/echo.HTTPError'
summary: Update donat voice settings.
tags:
- Donate
securityDefinitions:
BearerAuth:
in: header
name: Authorization
type: apiKey
swagger: "2.0"