Fix swagger errors
Some checks failed
Build Docker and Deploy / Build Docker Container (push) Successful in 1m27s
Build Docker and Deploy / Run Unit-Tests (push) Successful in 8m57s
Build Docker and Deploy / Deploy to Server (push) Failing after 8s

This commit is contained in:
2025-11-02 23:13:31 +01:00
parent b6944d1dbb
commit 31a45bc4c3
4 changed files with 236 additions and 16 deletions

View File

@@ -1954,6 +1954,43 @@ paths:
tags:
- API-v2
/api/v2/users/{uid}/channels/{cid}:
delete:
operationId: api-channels-delete
parameters:
- description: UserID
in: path
name: uid
required: true
type: string
- description: ChannelID
in: path
name: cid
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Channel'
"400":
description: supplied values/parameters cannot be parsed / are invalid
schema:
$ref: '#/definitions/ginresp.apiError'
"401":
description: user is not authorized / has missing permissions
schema:
$ref: '#/definitions/ginresp.apiError'
"404":
description: channel not found
schema:
$ref: '#/definitions/ginresp.apiError'
"500":
description: internal server error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: delete a channel (including all messages, subscriptions, etc)
tags:
- API-v2
get:
operationId: api-channels-get
parameters:
@@ -1992,7 +2029,7 @@ paths:
tags:
- API-v2
patch:
operationId: api-channels-delete
operationId: api-channels-update
parameters:
- description: UserID
in: path
@@ -2004,11 +2041,27 @@ paths:
name: cid
required: true
type: string
- description: Send `true` to create a new subscribe_key
in: body
name: subscribe_key
schema:
type: string
- description: Send `true` to create a new send_key
in: body
name: send_key
schema:
type: string
- description: Change the cahnnel display-name (only chnages to lowercase/uppercase
are allowed - internal_name must stay the same)
in: body
name: display_name
schema:
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Channel'
$ref: '#/definitions/models.ChannelWithSubscription'
"400":
description: supplied values/parameters cannot be parsed / are invalid
schema:
@@ -2025,7 +2078,7 @@ paths:
description: internal server error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: delete a channel (including all messages, subscriptions, etc)
summary: (Partially) update a channel
tags:
- API-v2
/api/v2/users/{uid}/channels/{cid}/messages:
@@ -2305,7 +2358,9 @@ paths:
- API-v2
/api/v2/users/{uid}/keys:
get:
operationId: api-usersendernames-list
description: The request must be done with an ADMIN key, the returned keys are
without their token.
operationId: api-tokenkeys-list
parameters:
- description: UserID
in: path
@@ -2333,7 +2388,7 @@ paths:
description: internal server error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: List sender-names (of allthe messages of this user)
summary: List keys of the user
tags:
- API-v2
post:
@@ -2533,6 +2588,39 @@ paths:
summary: Get the key currently used by this request
tags:
- API-v2
/api/v2/users/{uid}/sender-names:
get:
operationId: api-usersendernames-list
parameters:
- description: UserID
in: path
name: uid
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/handler.ListUserKeys.response'
"400":
description: supplied values/parameters cannot be parsed / are invalid
schema:
$ref: '#/definitions/ginresp.apiError'
"401":
description: user is not authorized / has missing permissions
schema:
$ref: '#/definitions/ginresp.apiError'
"404":
description: message not found
schema:
$ref: '#/definitions/ginresp.apiError'
"500":
description: internal server error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: List sender-names (of allthe messages of this user)
tags:
- API-v2
/api/v2/users/{uid}/subscriptions:
get:
description: |-