Mikescher/SimpleCloudNotifier
1
0
Fork 0
Code Pull Requests Actions Releases Activity

Update TODO.md

Browse Source
This commit is contained in:
Mike Schwörer
2023-06-10 00:15:42 +02:00
parent 5de4f67344
commit 7fefd251db
13 changed files with 425 additions and 329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
scnserver/swagger/swagger.json
View File

@@ -1154,7 +1154,7 @@
"operationId": "api-user-update",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
@@ -1221,7 +1221,7 @@
"operationId": "api-channels-list",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
@@ -1276,7 +1276,7 @@
"operationId": "api-channels-create",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
@@ -1389,14 +1389,14 @@
"operationId": "api-channels-update",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"type": "string",
"description": "ChannelID",
"name": "cid",
"in": "path",
@@ -1491,14 +1491,14 @@
"in": "query"
},
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"type": "string",
"description": "ChannelID",
"name": "cid",
"in": "path",
@@ -1647,7 +1647,7 @@
"operationId": "api-clients-create",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
@@ -1800,6 +1800,78 @@
}
}
}
},
"patch": {
"description": "The body-values are optional, only send the ones you want to update",
"tags": [
"API-v2"
],
"summary": "(Partially) update a client",
"operationId": "api-client-update",
"parameters": [
{
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "string",
"description": "ClientID",
"name": "cid",
"in": "path",
"required": true
},
{
"description": "Change the clientname (send an empty string to clear it)",
"name": "clientname",
"in": "body",
"schema": {
"type": "string"
}
},
{
"description": "Send a verification of premium purchase",
"name": "pro_token",
"in": "body",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.ClientJSON"
}
},
"400": {
"description": "supplied values/parameters cannot be parsed / are invalid",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "client is not authorized / has missing permissions",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "client not found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api/v2/users/{uid}/keys": {
@@ -1860,7 +1932,7 @@
"operationId": "api-tokenkeys-create",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
@@ -2030,14 +2102,14 @@
"operationId": "api-tokenkeys-update",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"type": "string",
"description": "TokenKeyID",
"name": "kid",
"in": "path",
@@ -2096,7 +2168,7 @@
"operationId": "api-user-subscriptions-list",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
@@ -2154,7 +2226,7 @@
"operationId": "api-subscriptions-create",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
@@ -2321,14 +2393,14 @@
"operationId": "api-subscriptions-update",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"type": "string",
"description": "SubscriptionID",
"name": "sid",
"in": "path",

78
scnserver/swagger/swagger.yaml
View File

@@ -1471,7 +1471,7 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: Change the username (send an empty string to clear it)
in: body
name: username
@@ -1521,7 +1521,7 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: 'Filter channels (default: owned)'
enum:
- owned
@@ -1559,7 +1559,7 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: ' '
in: body
name: post_body
@@ -1634,12 +1634,12 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: ChannelID
in: path
name: cid
required: true
type: integer
type: string
- description: Send `true` to create a new subscribe_key
in: body
name: subscribe_key
@@ -1705,12 +1705,12 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: ChannelID
in: path
name: cid
required: true
type: integer
type: string
responses:
"200":
description: OK
@@ -1809,7 +1809,7 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: ' '
in: body
name: post_body
@@ -1910,6 +1910,54 @@ paths:
summary: Get a single client
tags:
- API-v2
patch:
description: The body-values are optional, only send the ones you want to update
operationId: api-client-update
parameters:
- description: UserID
in: path
name: uid
required: true
type: string
- description: ClientID
in: path
name: cid
required: true
type: string
- description: Change the clientname (send an empty string to clear it)
in: body
name: clientname
schema:
type: string
- description: Send a verification of premium purchase
in: body
name: pro_token
schema:
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.ClientJSON'
"400":
description: supplied values/parameters cannot be parsed / are invalid
schema:
$ref: '#/definitions/ginresp.apiError'
"401":
description: client is not authorized / has missing permissions
schema:
$ref: '#/definitions/ginresp.apiError'
"404":
description: client not found
schema:
$ref: '#/definitions/ginresp.apiError'
"500":
description: internal server error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: (Partially) update a client
tags:
- API-v2
/api/v2/users/{uid}/keys:
get:
description: The request must be done with an ADMIN key, the returned keys are
@@ -1952,7 +2000,7 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: ' '
in: body
name: post_body
@@ -2067,12 +2115,12 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: TokenKeyID
in: path
name: kid
required: true
type: integer
type: string
- description: ' '
in: body
name: post_body
@@ -2118,7 +2166,7 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: 'Filter subscriptions (default: outgoing_all)'
enum:
- outgoing_all
@@ -2160,7 +2208,7 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- in: query
name: chan_subscribe_key
type: string
@@ -2271,12 +2319,12 @@ paths:
in: path
name: uid
required: true
type: integer
type: string
- description: SubscriptionID
in: path
name: sid
required: true
type: integer
type: string
- description: ' '
in: body
name: post_data