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

Add json tags to query structs (otherwise swag does not get the correct names)

Browse Source
This commit is contained in:
Mike Schwörer
2022-11-30 16:46:14 +01:00
parent 7a11b2c76f
commit b6e8d037a0
5 changed files with 163 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
server/swagger/swagger.json
View File

@@ -19,7 +19,7 @@
"parameters": [
{
"type": "string",
"name": "chanKey",
"name": "chan_key",
"in": "query"
},
{
@@ -32,19 +32,24 @@
"name": "content",
"in": "query"
},
{
"type": "string",
"name": "msg_id",
"in": "query"
},
{
"type": "integer",
"name": "priority",
"in": "query"
},
{
"type": "number",
"name": "sendTimestamp",
"type": "string",
"name": "sender_name",
"in": "query"
},
{
"type": "string",
"name": "senderName",
"type": "number",
"name": "timestamp",
"in": "query"
},
{
@@ -54,17 +59,12 @@
},
{
"type": "integer",
"name": "userID",
"name": "user_id",
"in": "query"
},
{
"type": "string",
"name": "userKey",
"in": "query"
},
{
"type": "string",
"name": "userMessageID",
"name": "user_key",
"in": "query"
},
{
@@ -394,12 +394,12 @@
},
{
"type": "string",
"name": "nextPageToken",
"name": "next_page_token",
"in": "query"
},
{
"type": "integer",
"name": "pageSize",
"name": "page_size",
"in": "query"
},
{
@@ -1334,12 +1334,12 @@
},
{
"type": "string",
"name": "nextPageToken",
"name": "next_page_token",
"in": "query"
},
{
"type": "integer",
"name": "pageSize",
"name": "page_size",
"in": "query"
},
{
@@ -1557,13 +1557,15 @@
}
}
}
},
"delete": {
}
},
"/api/users/{uid}/clients/{cid}": {
"get": {
"tags": [
"API-v2"
],
"summary": "Delete a client",
"operationId": "api-clients-delete",
"summary": "Get a single client",
"operationId": "api-clients-get",
"parameters": [
{
"type": "integer",
@@ -1612,15 +1614,13 @@
}
}
}
}
},
"/api/users/{uid}/clients/{cid}": {
"get": {
},
"delete": {
"tags": [
"API-v2"
],
"summary": "Get a single clients",
"operationId": "api-clients-get",
"summary": "Delete a client",
"operationId": "api-clients-delete",
"parameters": [
{
"type": "integer",
@@ -1736,7 +1736,7 @@
},
{
"type": "string",
"name": "chanSubscribeKey",
"name": "chan_subscribe_key",
"in": "query"
},
{
@@ -1959,7 +1959,7 @@
"parameters": [
{
"type": "string",
"name": "chanKey",
"name": "chan_key",
"in": "query"
},
{
@@ -1972,19 +1972,24 @@
"name": "content",
"in": "query"
},
{
"type": "string",
"name": "msg_id",
"in": "query"
},
{
"type": "integer",
"name": "priority",
"in": "query"
},
{
"type": "number",
"name": "sendTimestamp",
"type": "string",
"name": "sender_name",
"in": "query"
},
{
"type": "string",
"name": "senderName",
"type": "number",
"name": "timestamp",
"in": "query"
},
{
@@ -1994,17 +1999,12 @@
},
{
"type": "integer",
"name": "userID",
"name": "user_id",
"in": "query"
},
{
"type": "string",
"name": "userKey",
"in": "query"
},
{
"type": "string",
"name": "userMessageID",
"name": "user_key",
"in": "query"
},
{
@@ -2114,6 +2114,11 @@
"name": "content",
"in": "query"
},
{
"type": "string",
"name": "msg_id",
"in": "query"
},
{
"type": "integer",
"name": "priority",
@@ -2121,7 +2126,7 @@
},
{
"type": "number",
"name": "sendTimestamp",
"name": "timestamp",
"in": "query"
},
{
@@ -2131,17 +2136,12 @@
},
{
"type": "integer",
"name": "userID",
"name": "user_id",
"in": "query"
},
{
"type": "string",
"name": "userKey",
"in": "query"
},
{
"type": "string",
"name": "userMessageID",
"name": "user_key",
"in": "query"
},
{

138
server/swagger/swagger.yaml
View File

@@ -491,7 +491,7 @@ paths:
Only UserID, UserKey and Title are required
parameters:
- in: query
name: chanKey
name: chan_key
type: string
- in: query
name: channel
@@ -499,26 +499,26 @@ paths:
- in: query
name: content
type: string
- in: query
name: msg_id
type: string
- in: query
name: priority
type: integer
- in: query
name: sendTimestamp
type: number
- in: query
name: senderName
name: sender_name
type: string
- in: query
name: timestamp
type: number
- in: query
name: title
type: string
- in: query
name: userID
name: user_id
type: integer
- in: query
name: userKey
type: string
- in: query
name: userMessageID
name: user_key
type: string
- description: ' '
in: body
@@ -742,10 +742,10 @@ paths:
name: filter
type: string
- in: query
name: nextPageToken
name: next_page_token
type: string
- in: query
name: pageSize
name: page_size
type: integer
- description: TODO more filter (sender-name, channel, timestamps, prio, )
in: query
@@ -1386,10 +1386,10 @@ paths:
name: filter
type: string
- in: query
name: nextPageToken
name: next_page_token
type: string
- in: query
name: pageSize
name: page_size
type: integer
- in: query
name: trimmed
@@ -1467,43 +1467,6 @@ paths:
tags:
- API-v2
/api/users/{uid}/clients:
delete:
operationId: api-clients-delete
parameters:
- description: UserID
in: path
name: uid
required: true
type: integer
- description: ClientID
in: path
name: cid
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.ClientJSON'
"400":
description: Bad Request
schema:
$ref: '#/definitions/ginresp.apiError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/ginresp.apiError'
"404":
description: Not Found
schema:
$ref: '#/definitions/ginresp.apiError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: Delete a client
tags:
- API-v2
get:
operationId: api-clients-list
parameters:
@@ -1574,6 +1537,43 @@ paths:
tags:
- API-v2
/api/users/{uid}/clients/{cid}:
delete:
operationId: api-clients-delete
parameters:
- description: UserID
in: path
name: uid
required: true
type: integer
- description: ClientID
in: path
name: cid
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.ClientJSON'
"400":
description: Bad Request
schema:
$ref: '#/definitions/ginresp.apiError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/ginresp.apiError'
"404":
description: Not Found
schema:
$ref: '#/definitions/ginresp.apiError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: Delete a client
tags:
- API-v2
get:
operationId: api-clients-get
parameters:
@@ -1608,7 +1608,7 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/ginresp.apiError'
summary: Get a single clients
summary: Get a single client
tags:
- API-v2
/api/users/{uid}/subscriptions:
@@ -1653,7 +1653,7 @@ paths:
required: true
type: integer
- in: query
name: chanSubscribeKey
name: chan_subscribe_key
type: string
- description: ' '
in: body
@@ -1802,7 +1802,7 @@ paths:
Only UserID, UserKey and Title are required
parameters:
- in: query
name: chanKey
name: chan_key
type: string
- in: query
name: channel
@@ -1810,26 +1810,26 @@ paths:
- in: query
name: content
type: string
- in: query
name: msg_id
type: string
- in: query
name: priority
type: integer
- in: query
name: sendTimestamp
type: number
- in: query
name: senderName
name: sender_name
type: string
- in: query
name: timestamp
type: number
- in: query
name: title
type: string
- in: query
name: userID
name: user_id
type: integer
- in: query
name: userKey
type: string
- in: query
name: userMessageID
name: user_key
type: string
- description: ' '
in: body
@@ -1900,23 +1900,23 @@ paths:
- in: query
name: content
type: string
- in: query
name: msg_id
type: string
- in: query
name: priority
type: integer
- in: query
name: sendTimestamp
name: timestamp
type: number
- in: query
name: title
type: string
- in: query
name: userID
name: user_id
type: integer
- in: query
name: userKey
type: string
- in: query
name: userMessageID
name: user_key
type: string
- in: formData
name: content