Save SenderName || SenderIP per message

This commit is contained in:
2022-11-29 11:07:15 +01:00
parent 464cf3ec7e
commit ac9ae06cc8
14 changed files with 114 additions and 317 deletions

View File

@@ -42,6 +42,11 @@
"name": "sendTimestamp",
"in": "query"
},
{
"type": "string",
"name": "senderName",
"in": "query"
},
{
"type": "string",
"name": "title",
@@ -95,6 +100,11 @@
"name": "priority",
"in": "formData"
},
{
"type": "string",
"name": "sender_name",
"in": "formData"
},
{
"type": "number",
"name": "timestamp",
@@ -394,6 +404,7 @@
},
{
"type": "boolean",
"description": "TODO more filter (sender-name, channel, timestamps, prio, )",
"name": "trimmed",
"in": "query"
}
@@ -430,83 +441,6 @@
}
}
}
},
"post": {
"description": "This is similar to the main route `POST -\u003e https://scn.blackfrestbytes.com/`\nBut this route can change in the future, for long-living scripts etc. it's better to use the normal POST route",
"tags": [
"API-v2"
],
"summary": "Create a new message",
"operationId": "api-messages-create",
"parameters": [
{
"type": "string",
"name": "chan_key",
"in": "query"
},
{
"type": "string",
"name": "channel",
"in": "query"
},
{
"type": "string",
"name": "content",
"in": "query"
},
{
"type": "string",
"name": "msg_id",
"in": "query"
},
{
"type": "integer",
"name": "priority",
"in": "query"
},
{
"type": "number",
"name": "timestamp",
"in": "query"
},
{
"type": "string",
"name": "title",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.MessageJSON"
}
},
"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"
}
}
}
}
},
"/api/messages/{mid}": {
@@ -2048,6 +1982,11 @@
"name": "sendTimestamp",
"in": "query"
},
{
"type": "string",
"name": "senderName",
"in": "query"
},
{
"type": "string",
"name": "title",
@@ -2101,6 +2040,11 @@
"name": "priority",
"in": "formData"
},
{
"type": "string",
"name": "sender_name",
"in": "formData"
},
{
"type": "number",
"name": "timestamp",
@@ -2603,6 +2547,9 @@
"priority": {
"type": "integer"
},
"sender_name": {
"type": "string"
},
"timestamp": {
"type": "number"
},
@@ -2856,6 +2803,12 @@
"scn_message_id": {
"type": "integer"
},
"sender_ip": {
"type": "string"
},
"sender_name": {
"type": "string"
},
"sender_user_id": {
"type": "integer"
},

View File

@@ -216,6 +216,8 @@ definitions:
type: string
priority:
type: integer
sender_name:
type: string
timestamp:
type: number
title:
@@ -382,6 +384,10 @@ definitions:
type: integer
scn_message_id:
type: integer
sender_ip:
type: string
sender_name:
type: string
sender_user_id:
type: integer
timestamp:
@@ -499,6 +505,9 @@ paths:
- in: query
name: sendTimestamp
type: number
- in: query
name: senderName
type: string
- in: query
name: title
type: string
@@ -531,6 +540,9 @@ paths:
- in: formData
name: priority
type: integer
- in: formData
name: sender_name
type: string
- in: formData
name: timestamp
type: number
@@ -735,7 +747,8 @@ paths:
- in: query
name: pageSize
type: integer
- in: query
- description: TODO more filter (sender-name, channel, timestamps, prio, )
in: query
name: trimmed
type: boolean
responses:
@@ -762,57 +775,6 @@ paths:
summary: List all (subscribed) messages
tags:
- API-v2
post:
description: |-
This is similar to the main route `POST -> https://scn.blackfrestbytes.com/`
But this route can change in the future, for long-living scripts etc. it's better to use the normal POST route
operationId: api-messages-create
parameters:
- in: query
name: chan_key
type: string
- in: query
name: channel
type: string
- in: query
name: content
type: string
- in: query
name: msg_id
type: string
- in: query
name: priority
type: integer
- in: query
name: timestamp
type: number
- in: query
name: title
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.MessageJSON'
"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: Create a new message
tags:
- API-v2
/api/messages/{mid}:
delete:
description: The user must own the message and request the resource with the
@@ -1854,6 +1816,9 @@ paths:
- in: query
name: sendTimestamp
type: number
- in: query
name: senderName
type: string
- in: query
name: title
type: string
@@ -1886,6 +1851,9 @@ paths:
- in: formData
name: priority
type: integer
- in: formData
name: sender_name
type: string
- in: formData
name: timestamp
type: number