Mikescher/SimpleCloudNotifier
1
0
Fork 0
Code Pull Requests Actions Releases Activity
backend-rewrite
SimpleCloudNotifier/scnserver/swagger/swagger.json

3741 lines
131 KiB
JSON
Raw Permalink Normal View History

added template for new golang backend
2022-11-13 19:17:07 +01:00
{
"swagger": "2.0",
"info": {
"description": "API for SCN",
"title": "SimpleCloudNotifier API",
"contact": {},
"version": "2.0"
},
"host": "scn.blackforestbytes.com",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"basePath": "/",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"paths": {
SendMessage()
2022-11-19 15:13:47 +01:00
"/": {
"post": {
ListMessages()
2022-11-20 00:19:41 +01:00
"description": "All parameter can be set via query-parameter or the json body. Only UserID, UserKey and Title are required",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"External"
],
SendMessage()
2022-11-19 15:13:47 +01:00
"summary": "Send a new message",
"parameters": [
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "test",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "channel",
"in": "query"
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "This is a message",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "content",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
{
"type": "string",
"example": "P3TNH8mvv14fm",
"name": "key",
"in": "query"
},
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "db8b0e6a-a08c-4646",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "msg_id",
"in": "query"
},
SendMessage()
2022-11-19 15:13:47 +01:00
{
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"enum": [
0,
1,
2
],
SendMessage()
2022-11-19 15:13:47 +01:00
"type": "integer",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1,
SendMessage()
2022-11-19 15:13:47 +01:00
"name": "priority",
"in": "query"
},
{
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "example-server",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "sender_name",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
{
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"type": "number",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1669824037,
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "timestamp",
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
"in": "query"
},
SendMessage()
2022-11-19 15:13:47 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "Hello World",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "title",
"in": "query"
},
{
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string",
"example": "7725",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "user_id",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"$ref": "#/definitions/handler.SendMessage.combined"
SendMessage()
2022-11-19 15:13:47 +01:00
}
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "test",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "channel",
"in": "formData"
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "This is a message",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "content",
"in": "formData"
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
{
"type": "string",
"example": "P3TNH8mvv14fm",
"name": "key",
"in": "formData"
},
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "db8b0e6a-a08c-4646",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "msg_id",
"in": "formData"
},
{
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"enum": [
0,
1,
2
],
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"type": "integer",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1,
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "priority",
"in": "formData"
},
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "example-server",
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
"name": "sender_name",
"in": "formData"
},
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
{
"type": "number",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1669824037,
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "timestamp",
"in": "formData"
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "Hello World",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "title",
"in": "formData"
},
{
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string",
"example": "7725",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "user_id",
"in": "formData"
SendMessage()
2022-11-19 15:13:47 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"$ref": "#/definitions/handler.SendMessage.response"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
update HTML with new methods
2022-11-21 22:52:44 +01:00
"description": "The user_id was not found or the user_key is wrong",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"403": {
update HTML with new methods
2022-11-21 22:52:44 +01:00
"description": "The user has exceeded its daily quota - wait 24 hours or upgrade your account",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
update HTML with new methods
2022-11-21 22:52:44 +01:00
"description": "An internal server error occurred - try again later",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"/api/ack.php": {
"get": {
"tags": [
"API-v1"
],
"summary": "Acknowledge that a message was received",
"operationId": "compat-ack",
"deprecated": true,
"parameters": [
{
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the message id",
"name": "scn_msg_id",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the message id",
"name": "scn_msg_id",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"schema": {
"$ref": "#/definitions/handler.Ack.response"
}
},
"default": {
"description": "",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.compatAPIError"
}
}
}
}
},
"/api/db-test": {
Added google androidpublisher/v3 api to verify google purchase tokens
2022-11-25 22:42:21 +01:00
"post": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"Common"
],
Tests[ListChannelsDefault, ListChannelsOwned, ListChannelsSubscribedAny, ListChannelsAllAny, ListChannelsSubscribed, ListChannelsAll]
2022-12-22 17:29:59 +01:00
"summary": "Check for a working database connection",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"operationId": "api-common-dbtest",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.DatabaseTest.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api/expand.php": {
"get": {
"tags": [
"API-v1"
],
"summary": "Get a whole (potentially truncated) message",
"operationId": "compat-expand",
"deprecated": true,
"parameters": [
{
"type": "string",
"description": "The user_id",
"name": "user_id",
"in": "query",
"required": true
},
{
"type": "string",
"description": "The user_key",
"name": "user_key",
"in": "query",
"required": true
},
{
"type": "string",
"description": "The message-id",
"name": "scn_msg_id",
"in": "query",
"required": true
},
{
"type": "string",
"description": "The user_id",
"name": "user_id",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "The user_key",
"name": "user_key",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "The message-id",
"name": "scn_msg_id",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"schema": {
"$ref": "#/definitions/handler.Expand.response"
}
},
"default": {
"description": "",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.compatAPIError"
}
}
}
}
},
"/api/health": {
"get": {
"tags": [
"Common"
],
"summary": "Server Health-checks",
"operationId": "api-common-health",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Health.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api/info.php": {
"get": {
"tags": [
"API-v1"
],
"summary": "Get information about the current user",
"operationId": "compat-info",
"deprecated": true,
"parameters": [
{
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"schema": {
"$ref": "#/definitions/handler.Info.response"
}
},
"default": {
"description": "",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.compatAPIError"
}
}
}
}
},
"/api/ping": {
"get": {
"tags": [
"Common"
ListMessages()
2022-11-20 00:19:41 +01:00
],
tags/grouping for API
2022-11-23 19:32:23 +01:00
"summary": "Simple endpoint to test connection (any http method)",
ListMessages()
2022-11-20 00:19:41 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/handler.pingResponse"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"500": {
"description": "Internal Server Error",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
}
},
"put": {
"tags": [
"Common"
],
"summary": "Simple endpoint to test connection (any http method)",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.pingResponse"
}
ListMessages()
2022-11-20 00:19:41 +01:00
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
"post": {
"tags": [
"Common"
ListMessages()
2022-11-20 00:19:41 +01:00
],
tags/grouping for API
2022-11-23 19:32:23 +01:00
"summary": "Simple endpoint to test connection (any http method)",
ListMessages()
2022-11-20 00:19:41 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/handler.pingResponse"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"500": {
"description": "Internal Server Error",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
}
},
"delete": {
"tags": [
"Common"
],
"summary": "Simple endpoint to test connection (any http method)",
"responses": {
"200": {
"description": "OK",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/handler.pingResponse"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"patch": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"Common"
ListMessages()
2022-11-20 00:19:41 +01:00
],
tags/grouping for API
2022-11-23 19:32:23 +01:00
"summary": "Simple endpoint to test connection (any http method)",
ListMessages()
2022-11-20 00:19:41 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/handler.pingResponse"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"/api/register.php": {
ListMessages()
2022-11-20 00:19:41 +01:00
"get": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v1"
],
"summary": "Register a new account",
"operationId": "compat-register",
"deprecated": true,
ListMessages()
2022-11-20 00:19:41 +01:00
"parameters": [
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the (android) fcm token",
"name": "fcm_token",
"in": "query",
ListMessages()
2022-11-20 00:19:41 +01:00
"required": true
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
},
{
"enum": [
tags/grouping for API
2022-11-23 19:32:23 +01:00
"true",
"false"
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
],
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "if the user is a paid account",
"name": "pro",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the (android) IAP token",
"name": "pro_token",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"in": "query",
"required": true
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
{
"type": "string",
"description": "the (android) fcm token",
"name": "fcm_token",
"in": "formData",
"required": true
},
{
"enum": [
"true",
"false"
],
"type": "string",
"description": "if the user is a paid account",
"name": "pro",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the (android) IAP token",
"name": "pro_token",
"in": "formData",
"required": true
ListMessages()
2022-11-20 00:19:41 +01:00
}
],
"responses": {
"200": {
"description": "OK",
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"schema": {
"$ref": "#/definitions/handler.Register.response"
}
},
"default": {
"description": "",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/ginresp.compatAPIError"
ListMessages()
2022-11-20 00:19:41 +01:00
}
}
}
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"/api/requery.php": {
ListMessages()
2022-11-20 00:19:41 +01:00
"get": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v1"
],
"summary": "Return all not-acknowledged messages",
"operationId": "compat-requery",
"deprecated": true,
ListMessages()
2022-11-20 00:19:41 +01:00
"parameters": [
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "query",
ListMessages()
2022-11-20 00:19:41 +01:00
"required": true
},
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "formData",
ListMessages()
2022-11-20 00:19:41 +01:00
"required": true
}
],
"responses": {
"200": {
"description": "OK",
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"schema": {
"$ref": "#/definitions/handler.Requery.response"
}
},
"default": {
"description": "",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/ginresp.compatAPIError"
ListMessages()
2022-11-20 00:19:41 +01:00
}
}
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
},
tests (boilerplate)
2022-11-23 20:21:49 +01:00
"/api/sleep/{secs}": {
"post": {
"tags": [
"Common"
],
"summary": "Return 200 after x seconds",
"operationId": "api-common-sleep",
cleanup swagger
2022-11-23 22:12:47 +01:00
"parameters": [
{
"type": "number",
"description": "sleep delay (in seconds)",
"name": "secs",
"in": "path",
"required": true
}
],
tests (boilerplate)
2022-11-23 20:21:49 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Sleep.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"/api/update.php": {
"get": {
"tags": [
"API-v1"
],
"summary": "Set the fcm-token (android)",
"operationId": "compat-update",
"deprecated": true,
Routes to refresh user and channel keys
2022-11-20 21:35:08 +01:00
"parameters": [
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "query",
"required": true
Routes to refresh user and channel keys
2022-11-20 21:35:08 +01:00
},
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "query",
Routes to refresh user and channel keys
2022-11-20 21:35:08 +01:00
"required": true
},
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the (android) fcm token",
"name": "fcm_token",
"in": "query",
"required": true
Routes to refresh user and channel keys
2022-11-20 21:35:08 +01:00
},
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the (android) fcm token",
"name": "fcm_token",
"in": "formData",
"required": true
Routes to refresh user and channel keys
2022-11-20 21:35:08 +01:00
}
],
"responses": {
"200": {
"description": "OK",
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"schema": {
"$ref": "#/definitions/handler.Update.response"
}
},
"default": {
"description": "",
Routes to refresh user and channel keys
2022-11-20 21:35:08 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/ginresp.compatAPIError"
Routes to refresh user and channel keys
2022-11-20 21:35:08 +01:00
}
}
}
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"/api/upgrade.php": {
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"get": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v1"
],
"summary": "Upgrade a free account to a paid account",
"operationId": "compat-upgrade",
"deprecated": true,
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"parameters": [
{
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "the user_id",
"name": "user_id",
"in": "query",
"required": true
ListChannelMessages()
2022-11-20 00:30:30 +01:00
},
{
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "the user_key",
"name": "user_key",
"in": "query",
"required": true
ListChannelMessages()
2022-11-20 00:30:30 +01:00
},
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"enum": [
"true",
"false"
],
"type": "string",
"description": "if the user is a paid account",
"name": "pro",
"in": "query",
"required": true
ListChannelMessages()
2022-11-20 00:30:30 +01:00
},
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
"description": "the (android) IAP token",
"name": "pro_token",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the user_id",
"name": "user_id",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the user_key",
"name": "user_key",
"in": "formData",
"required": true
},
{
"enum": [
"true",
"false"
],
"type": "string",
"description": "if the user is a paid account",
"name": "pro",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "the (android) IAP token",
"name": "pro_token",
"in": "formData",
"required": true
ListChannelMessages()
2022-11-20 00:30:30 +01:00
}
],
"responses": {
"200": {
"description": "OK",
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"schema": {
"$ref": "#/definitions/handler.Upgrade.response"
}
},
"default": {
"description": "",
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/ginresp.compatAPIError"
ListChannelMessages()
2022-11-20 00:30:30 +01:00
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
}
}
},
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
"/api/v2/messages": {
"get": {
"description": "The next_page_token is an opaque token, the special value \"@start\" (or empty-string) is the beginning and \"@end\" is the end\nSimply start the pagination without a next_page_token and get the next page by calling this endpoint with the returned next_page_token of the last query\nIf there are no more entries the token \"@end\" will be returned\nBy default we return long messages with a trimmed body, if trimmed=false is supplied we return full messages (this reduces the max page_size)",
"tags": [
"API-v2"
],
"summary": "List all (subscribed) messages",
"operationId": "api-messages-list",
"parameters": [
fix swagger errors
2023-05-28 17:04:44 +02:00
{
"type": "string",
"description": "RFC3339",
"name": "after",
"in": "query"
},
{
"type": "string",
"description": "RFC3339",
"name": "before",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "channel",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "channel_id",
"in": "query"
},
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
{
"type": "string",
"name": "filter",
"in": "query"
},
{
"type": "string",
"name": "next_page_token",
"in": "query"
},
{
"type": "integer",
"name": "page_size",
"in": "query"
},
fix swagger errors
2023-05-28 17:04:44 +02:00
{
"type": "array",
"items": {
"type": "integer"
},
"collectionFormat": "csv",
"name": "priority",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "sender",
"in": "query"
},
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
{
"type": "boolean",
"name": "trimmed",
"in": "query"
fix swagger errors
2023-05-28 17:04:44 +02:00
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "used_key",
"in": "query"
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.ListMessages.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"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api/v2/messages/{mid}": {
"delete": {
"description": "The user must own the message and request the resource with the ADMIN Key",
"tags": [
"API-v2"
],
"summary": "Delete a single message",
"operationId": "api-messages-delete",
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
"description": "MessageID",
"name": "mid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.MessageJSON"
}
},
"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"
}
}
}
},
"patch": {
"description": "The user must either own the message and request the resource with the READ or ADMIN Key\nOr the user must subscribe to the corresponding channel (and be confirmed) and request the resource with the READ or ADMIN Key\nThe returned message is never trimmed",
"tags": [
"API-v2"
],
"summary": "Get a single message (untrimmed)",
"operationId": "api-messages-get",
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
"description": "MessageID",
"name": "mid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.MessageJSON"
}
},
"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"
}
}
}
}
},
"/api/v2/users": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"post": {
"tags": [
"API-v2"
],
"summary": "Create a new user",
"operationId": "api-user-create",
"parameters": [
{
"description": " ",
"name": "post_body",
"in": "body",
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/handler.CreateUser.body"
ListChannelMessages()
2022-11-20 00:30:30 +01:00
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
],
"responses": {
"200": {
"description": "OK",
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"schema": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"$ref": "#/definitions/models.UserJSONWithClientsAndKeys"
}
},
"400": {
"description": "supplied values/parameters cannot be parsed / are invalid",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"/api/v2/users/{uid}": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"get": {
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Get a user",
"operationId": "api-user-get",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.UserJSON"
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
}
},
"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": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "user not found",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"patch": {
"description": "The body-values are optional, only send the ones you want to update",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "(Partially) update a user",
"operationId": "api-user-update",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "Change the username (send an empty string to clear it)",
"name": "username",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"in": "body",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string"
}
},
{
"description": "Send a verification of premium purchase",
"name": "pro_token",
"in": "body",
"schema": {
"type": "string"
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.UserJSON"
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
}
},
"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": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "user not found",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"/api/v2/users/{uid}/channels": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"get": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "The possible values for 'selector' are:\n- \"owned\" Return all channels of the user\n- \"subscribed\" Return all channels that the user is subscribing to\n- \"all\" Return channels that the user owns or is subscribing\n- \"subscribed_any\" Return all channels that the user is subscribing to (even unconfirmed)\n- \"all_any\" Return channels that the user owns or is subscribing (even unconfirmed)",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "List channels of a user (subscribed/owned/all)",
"operationId": "api-channels-list",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
fix swagger errors
2023-05-28 17:04:44 +02:00
{
"enum": [
"owned",
"subscribed",
"all",
"subscribed_any",
"all_any"
],
"type": "string",
"description": "Filter channels (default: owned)",
"name": "selector",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.ListChannels.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"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"post": {
"tags": [
"API-v2"
],
"summary": "Create a new (empty) channel",
"operationId": "api-channels-create",
"parameters": [
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "UserID",
"name": "uid",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"in": "path",
"required": true
fix swagger errors
2023-05-28 17:04:44 +02:00
},
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.CreateChannel.body"
}
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.ChannelWithSubscriptionJSON"
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
}
},
"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"
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"409": {
"description": "channel already exists",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
fix swagger errors
2023-05-28 17:04:44 +02:00
}
},
"/api/v2/users/{uid}/channels/{cid}": {
"get": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Get a single channel",
"operationId": "api-channels-get",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
"description": "ChannelID",
"name": "cid",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.ChannelWithSubscriptionJSON"
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
}
},
"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": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "channel not found",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"patch": {
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "(Partially) update a channel",
"operationId": "api-channels-update",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "ChannelID",
"name": "cid",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"in": "path",
"required": true
split api.go into multiple files
2023-05-28 13:39:20 +02:00
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "Send `true` to create a new subscribe_key",
"name": "subscribe_key",
split api.go into multiple files
2023-05-28 13:39:20 +02:00
"in": "body",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string"
}
},
{
"description": "Send `true` to create a new send_key",
"name": "send_key",
"in": "body",
"schema": {
"type": "string"
}
},
{
"description": "Change the cahnnel display-name (only chnages to lowercase/uppercase are allowed - internal_name must stay the same)",
"name": "display_name",
"in": "body",
"schema": {
"type": "string"
split api.go into multiple files
2023-05-28 13:39:20 +02:00
}
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.ChannelWithSubscriptionJSON"
ListChannelMessages()
2022-11-20 00:30:30 +01:00
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"401": {
"description": "user is not authorized / has missing permissions",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "channel not found",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"/api/v2/users/{uid}/channels/{cid}/messages": {
ListMessages()
2022-11-20 00:19:41 +01:00
"get": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "The next_page_token is an opaque token, the special value \"@start\" (or empty-string) is the beginning and \"@end\" is the end\nSimply start the pagination without a next_page_token and get the next page by calling this endpoint with the returned next_page_token of the last query\nIf there are no more entries the token \"@end\" will be returned\nBy default we return long messages with a trimmed body, if trimmed=false is supplied we return full messages (this reduces the max page_size)",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "List messages of a channel",
"operationId": "api-channel-messages",
ListMessages()
2022-11-20 00:19:41 +01:00
"parameters": [
fix swagger errors
2023-05-28 17:04:44 +02:00
{
"type": "string",
"name": "filter",
"in": "query"
},
{
"type": "string",
"name": "next_page_token",
"in": "query"
},
{
"type": "integer",
"name": "page_size",
"in": "query"
},
{
"type": "boolean",
"name": "trimmed",
"in": "query"
},
ListMessages()
2022-11-20 00:19:41 +01:00
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
fix swagger errors
2023-05-28 17:04:44 +02:00
},
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "ChannelID",
"name": "cid",
"in": "path",
"required": true
ListMessages()
2022-11-20 00:19:41 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/handler.ListChannelMessages.response"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "channel not found",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
fix swagger errors
2023-05-28 17:04:44 +02:00
}
},
"/api/v2/users/{uid}/channels/{cid}/subscriptions": {
"get": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "List all subscriptions of a channel",
"operationId": "api-chan-subscriptions-list",
ListMessages()
2022-11-20 00:19:41 +01:00
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
"description": "ChannelID",
"name": "cid",
"in": "path",
"required": true
ListMessages()
2022-11-20 00:19:41 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/handler.ListChannelSubscriptions.response"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "channel not found",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"/api/v2/users/{uid}/clients": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"get": {
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "List all clients",
"operationId": "api-clients-list",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"parameters": [
{
"type": "string",
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
ListMessages()
2022-11-20 00:19:41 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/handler.ListClients.response"
ListMessages()
2022-11-20 00:19:41 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
},
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"post": {
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Add a new clients",
"operationId": "api-clients-create",
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/handler.AddClient.body"
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.ClientJSON"
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
}
},
"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"
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"/api/v2/users/{uid}/clients/{cid}": {
ListMessages()
2022-11-20 00:19:41 +01:00
"get": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Get a single client",
"operationId": "api-clients-get",
ListMessages()
2022-11-20 00:19:41 +01:00
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
"description": "ClientID",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "cid",
"in": "path",
"required": true
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.ClientJSON"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "client not found",
ListMessages()
2022-11-20 00:19:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"delete": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Delete a client",
"operationId": "api-clients-delete",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
"description": "ClientID",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"name": "cid",
"in": "path",
"required": true
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.ClientJSON"
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "client not found",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
Update TODO.md
2023-06-10 00:15:42 +02:00
},
"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"
}
}
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"/api/v2/users/{uid}/keys": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"get": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "The request must be done with an ADMIN key, the returned keys are without their token.",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "List keys of the user",
"operationId": "api-tokenkeys-list",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"parameters": [
ListMessages()
2022-11-20 00:19:41 +01:00
{
tags/grouping for API
2022-11-23 19:32:23 +01:00
"type": "string",
cleanup swagger
2022-11-23 22:12:47 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/handler.ListUserKeys.response"
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "message not found",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
fix swagger errors
2023-05-28 17:04:44 +02:00
},
"post": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Create a new key",
"operationId": "api-tokenkeys-create",
ListClients()
2022-11-19 12:47:23 +01:00
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
ListClients()
2022-11-19 12:47:23 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
ListMessages()
2022-11-20 00:19:41 +01:00
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.CreateUserKey.body"
}
ListClients()
2022-11-19 12:47:23 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.KeyTokenJSON"
ListClients()
2022-11-19 12:47:23 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
ListClients()
2022-11-19 12:47:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
ListClients()
2022-11-19 12:47:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "message not found",
ListClients()
2022-11-19 12:47:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
GetClient()
2022-11-19 12:50:41 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
GetClient()
2022-11-19 12:50:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"/api/v2/users/{uid}/keys/{kid}": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"get": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "The request must be done with an ADMIN key, the returned key does not include its token.",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Get a single key",
"operationId": "api-tokenkeys-get",
DeleteClient()
2022-11-19 12:59:25 +01:00
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
DeleteClient()
2022-11-19 12:59:25 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
cleanup swagger
2022-11-23 22:12:47 +01:00
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
"description": "TokenKeyID",
"name": "kid",
cleanup swagger
2022-11-23 22:12:47 +01:00
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.KeyTokenJSON"
cleanup swagger
2022-11-23 22:12:47 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
cleanup swagger
2022-11-23 22:12:47 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
cleanup swagger
2022-11-23 22:12:47 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"404": {
"description": "message not found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
cleanup swagger
2022-11-23 22:12:47 +01:00
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
cleanup swagger
2022-11-23 22:12:47 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
fix swagger errors
2023-05-28 17:04:44 +02:00
},
"delete": {
"description": "Cannot be used to delete the key used in the request itself",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Delete a key",
"operationId": "api-tokenkeys-delete",
GetClient()
2022-11-19 12:50:41 +01:00
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
GetClient()
2022-11-19 12:50:41 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
"description": "TokenKeyID",
"name": "kid",
GetClient()
2022-11-19 12:50:41 +01:00
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.KeyTokenJSON"
GetClient()
2022-11-19 12:50:41 +01:00
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
GetClient()
2022-11-19 12:50:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
GetClient()
2022-11-19 12:50:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "message not found",
GetClient()
2022-11-19 12:50:41 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
ListClients()
2022-11-19 12:47:23 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
ListClients()
2022-11-19 12:47:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
},
fix swagger errors
2023-05-28 17:04:44 +02:00
"patch": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
added template for new golang backend
2022-11-13 19:17:07 +01:00
],
fix swagger errors
2023-05-28 17:04:44 +02:00
"summary": "Update a key",
"operationId": "api-tokenkeys-update",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
swagger doku for compat methods
2022-11-20 13:18:09 +01:00
"required": true
},
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "TokenKeyID",
"name": "kid",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"in": "path",
swagger doku for compat methods
2022-11-20 13:18:09 +01:00
"required": true
fix swagger errors
2023-05-28 17:04:44 +02:00
},
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.UpdateUserKey.body"
}
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"$ref": "#/definitions/models.KeyTokenJSON"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/ginresp.apiError"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
"404": {
fix swagger errors
2023-05-28 17:04:44 +02:00
"description": "message not found",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/ginresp.apiError"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
"/api/v2/users/{uid}/subscriptions": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"get": {
Tests[ListChannelsDefault, ListChannelsOwned, ListChannelsSubscribedAny, ListChannelsAllAny, ListChannelsSubscribed, ListChannelsAll]
2022-12-22 17:29:59 +01:00
"description": "The possible values for 'selector' are:\n- \"outgoing_all\" All subscriptions (confirmed/unconfirmed) with the user as subscriber (= subscriptions he can use to read channels)\n- \"outgoing_confirmed\" Confirmed subscriptions with the user as subscriber\n- \"outgoing_unconfirmed\" Unconfirmed (Pending) subscriptions with the user as subscriber\n- \"incoming_all\" All subscriptions (confirmed/unconfirmed) from other users to channels of this user (= incoming subscriptions and subscription requests)\n- \"incoming_confirmed\" Confirmed subscriptions from other users to channels of this user\n- \"incoming_unconfirmed\" Unconfirmed subscriptions from other users to channels of this user (= requests)",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
"summary": "List all subscriptions of a user (incoming/owned)",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"operationId": "api-user-subscriptions-list",
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
},
{
"enum": [
Tests[ListChannelsDefault, ListChannelsOwned, ListChannelsSubscribedAny, ListChannelsAllAny, ListChannelsSubscribed, ListChannelsAll]
2022-12-22 17:29:59 +01:00
"outgoing_all",
"outgoing_confirmed",
"outgoing_unconfirmed",
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
"incoming_all",
"incoming_confirmed",
"incoming_unconfirmed"
],
"type": "string",
split api.go into multiple files
2023-05-28 13:39:20 +02:00
"description": "Filter subscriptions (default: outgoing_all)",
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
"name": "selector",
"in": "query",
"required": true
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
],
`POST:/users` works
2022-11-18 21:25:40 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/handler.ListUserSubscriptions.response"
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
tags/grouping for API
2022-11-23 19:32:23 +01:00
"post": {
Fix SQL unmarshalling of optional nested structs (LEFT JOIN)
2022-12-22 12:43:40 +01:00
"description": "Either [channel_owner_user_id, channel_internal_name] or [channel_id] must be supplied in the request body",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
Fix SQL unmarshalling of optional nested structs (LEFT JOIN)
2022-12-22 12:43:40 +01:00
"summary": "Create/Request a subscription",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"operationId": "api-subscriptions-create",
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "string",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "chan_subscribe_key",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"in": "query"
},
{
"description": " ",
"name": "post_data",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.CreateSubscription.body"
}
}
],
`POST:/users` works
2022-11-18 21:25:40 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
},
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
"/api/v2/users/{uid}/subscriptions/{sid}": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"get": {
"tags": [
"API-v2"
],
"summary": "Get a single subscription",
"operationId": "api-subscriptions-get",
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "SubscriptionID",
"name": "sid",
"in": "path",
"required": true
}
],
`POST:/users` works
2022-11-18 21:25:40 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "subscription not found",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"delete": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
"summary": "Cancel (delete) subscription",
"operationId": "api-subscriptions-delete",
"parameters": [
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
fix swagger errors
2023-05-28 17:04:44 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "SubscriptionID",
"name": "sid",
"in": "path",
"required": true
}
],
`POST:/users` works
2022-11-18 21:25:40 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "subscription not found",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"patch": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"API-v2"
],
"summary": "Update a subscription (e.g. confirm)",
"operationId": "api-subscriptions-update",
"parameters": [
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
Update TODO.md
2023-06-10 00:15:42 +02:00
"type": "string",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"description": "SubscriptionID",
"name": "sid",
"in": "path",
"required": true
Tests[ListChannelsDefault, ListChannelsOwned, ListChannelsSubscribedAny, ListChannelsAllAny, ListChannelsSubscribed, ListChannelsAll]
2022-12-22 17:29:59 +01:00
},
{
"description": " ",
"name": "post_data",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.UpdateSubscription.body"
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
],
`POST:/users` works
2022-11-18 21:25:40 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
tags/grouping for API
2022-11-23 19:32:23 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
}
},
"400": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "supplied values/parameters cannot be parsed / are invalid",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "user is not authorized / has missing permissions",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "subscription not found",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"500": {
Added error descriptions to swagger
2022-12-14 14:27:41 +01:00
"description": "internal server error",
`POST:/users` works
2022-11-18 21:25:40 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
SendMessage()
2022-11-19 15:13:47 +01:00
},
"/send": {
"post": {
ListMessages()
2022-11-20 00:19:41 +01:00
"description": "All parameter can be set via query-parameter or the json body. Only UserID, UserKey and Title are required",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"External"
],
SendMessage()
2022-11-19 15:13:47 +01:00
"summary": "Send a new message",
"parameters": [
ListMessages()
2022-11-20 00:19:41 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "test",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "channel",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "This is a message",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "content",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
{
"type": "string",
"example": "P3TNH8mvv14fm",
"name": "key",
"in": "query"
},
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "db8b0e6a-a08c-4646",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "msg_id",
"in": "query"
},
SendMessage()
2022-11-19 15:13:47 +01:00
{
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"enum": [
0,
1,
2
],
SendMessage()
2022-11-19 15:13:47 +01:00
"type": "integer",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1,
SendMessage()
2022-11-19 15:13:47 +01:00
"name": "priority",
"in": "query"
},
{
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "example-server",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "sender_name",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
{
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"type": "number",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1669824037,
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "timestamp",
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
"in": "query"
},
SendMessage()
2022-11-19 15:13:47 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "Hello World",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "title",
"in": "query"
},
{
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string",
"example": "7725",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "user_id",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"$ref": "#/definitions/handler.SendMessage.combined"
SendMessage()
2022-11-19 15:13:47 +01:00
}
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "test",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "channel",
"in": "formData"
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "This is a message",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "content",
"in": "formData"
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
{
"type": "string",
"example": "P3TNH8mvv14fm",
"name": "key",
"in": "formData"
},
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "db8b0e6a-a08c-4646",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "msg_id",
"in": "formData"
},
{
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"enum": [
0,
1,
2
],
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"type": "integer",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1,
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "priority",
"in": "formData"
},
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "example-server",
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
"name": "sender_name",
"in": "formData"
},
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
{
"type": "number",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": 1669824037,
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "timestamp",
"in": "formData"
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"example": "Hello World",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "title",
"in": "formData"
},
{
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string",
"example": "7725",
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"name": "user_id",
"in": "formData"
SendMessage()
2022-11-19 15:13:47 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"$ref": "#/definitions/handler.SendMessage.response"
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
update HTML with new methods
2022-11-21 22:52:44 +01:00
"description": "The user_id was not found or the user_key is wrong",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"403": {
update HTML with new methods
2022-11-21 22:52:44 +01:00
"description": "The user has exceeded its daily quota - wait 24 hours or upgrade your account",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
update HTML with new methods
2022-11-21 22:52:44 +01:00
"description": "An internal server error occurred - try again later",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/send.php": {
"post": {
"description": "All parameter can be set via query-parameter or form-data body. Only UserID, UserKey and Title are required",
tags/grouping for API
2022-11-23 19:32:23 +01:00
"tags": [
"External"
],
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"summary": "Send a new message (compatibility)",
"deprecated": true,
"parameters": [
{
"type": "string",
"name": "content",
"in": "query"
},
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
{
"type": "string",
"name": "msg_id",
"in": "query"
},
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
{
"type": "integer",
"name": "priority",
"in": "query"
},
{
"type": "number",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "timestamp",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"in": "query"
},
{
"type": "string",
"name": "title",
"in": "query"
},
{
"type": "integer",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "user_id",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"in": "query"
},
{
"type": "string",
Add json tags to query structs (otherwise swag does not get the correct names)
2022-11-30 16:46:14 +01:00
"name": "user_key",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"in": "query"
},
{
"type": "string",
"name": "content",
"in": "formData"
},
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
{
"type": "string",
"name": "msg_id",
"in": "formData"
},
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
{
"type": "integer",
"name": "priority",
"in": "formData"
},
{
"type": "number",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"name": "timestamp",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"in": "formData"
},
{
"type": "string",
"name": "title",
"in": "formData"
},
{
"type": "integer",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"name": "user_id",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"in": "formData"
},
{
"type": "string",
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"name": "user_key",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"in": "formData"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"$ref": "#/definitions/handler.SendMessageCompat.response"
SendMessage()
2022-11-19 15:13:47 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
SendMessage()
2022-11-19 15:13:47 +01:00
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"definitions": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"apierr.APIError": {
"type": "integer",
"enum": [
-1,
0,
1101,
1102,
1103,
1104,
1105,
1106,
1121,
1151,
1152,
1153,
1161,
1171,
1201,
1202,
1203,
1204,
1205,
1206,
1207,
1208,
split api.go into multiple files
2023-05-28 13:39:20 +02:00
1209,
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
1301,
1302,
1303,
1304,
1305,
1306,
1307,
1311,
1401,
1501,
1511,
split api.go into multiple files
2023-05-28 13:39:20 +02:00
1512,
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
2101,
3001,
3002,
9901,
9902,
9903,
9904,
9905
],
"x-enum-varnames": [
"UNDEFINED",
"NO_ERROR",
"MISSING_UID",
"MISSING_TOK",
"MISSING_TITLE",
"INVALID_PRIO",
"REQ_METHOD",
"INVALID_CLIENTTYPE",
"PAGETOKEN_ERROR",
"BINDFAIL_QUERY_PARAM",
"BINDFAIL_BODY_PARAM",
"BINDFAIL_URI_PARAM",
"INVALID_BODY_PARAM",
"INVALID_ENUM_VALUE",
"NO_TITLE",
"TITLE_TOO_LONG",
"CONTENT_TOO_LONG",
"USR_MSG_ID_TOO_LONG",
"TIMESTAMP_OUT_OF_RANGE",
"SENDERNAME_TOO_LONG",
"CHANNEL_TOO_LONG",
"CHANNEL_DESCRIPTION_TOO_LONG",
split api.go into multiple files
2023-05-28 13:39:20 +02:00
"CHANNEL_NAME_EMPTY",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"USER_NOT_FOUND",
"CLIENT_NOT_FOUND",
"CHANNEL_NOT_FOUND",
"SUBSCRIPTION_NOT_FOUND",
"MESSAGE_NOT_FOUND",
"SUBSCRIPTION_USER_MISMATCH",
"KEY_NOT_FOUND",
"USER_AUTH_FAILED",
"NO_DEVICE_LINKED",
"CHANNEL_ALREADY_EXISTS",
"CANNOT_SELFDELETE_KEY",
split api.go into multiple files
2023-05-28 13:39:20 +02:00
"CANNOT_SELFUPDATE_KEY",
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"QUOTA_REACHED",
"FAILED_VERIFY_PRO_TOKEN",
"INVALID_PRO_TOKEN",
"FIREBASE_COM_FAILED",
"FIREBASE_COM_ERRORED",
"INTERNAL_EXCEPTION",
"PANIC",
"NOT_IMPLEMENTED"
]
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"ginresp.apiError": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"type": "object",
"properties": {
"errhighlight": {
"type": "integer"
},
"error": {
"type": "integer"
},
"message": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
compat methods
2022-11-20 01:28:32 +01:00
"ginresp.compatAPIError": {
"type": "object",
"properties": {
"errid": {
"type": "integer"
},
"message": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"handler.Ack.response": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"new_ack": {
"type": "integer"
},
"prev_ack": {
"type": "integer"
},
"success": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
DeleteClient()
2022-11-19 12:59:25 +01:00
"handler.AddClient.body": {
"type": "object",
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"required": [
"agent_model",
"agent_version",
"client_type",
"fcm_token"
],
DeleteClient()
2022-11-19 12:59:25 +01:00
"properties": {
"agent_model": {
"type": "string"
},
"agent_version": {
"type": "string"
},
"client_type": {
"type": "string"
},
"fcm_token": {
"type": "string"
}
}
},
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"handler.CreateChannel.body": {
"type": "object",
"properties": {
"name": {
"type": "string"
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
},
"subscribe": {
"type": "boolean"
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"handler.CreateSubscription.body": {
"type": "object",
"properties": {
Fix SQL unmarshalling of optional nested structs (LEFT JOIN)
2022-12-22 12:43:40 +01:00
"channel_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
Fix SQL unmarshalling of optional nested structs (LEFT JOIN)
2022-12-22 12:43:40 +01:00
},
"channel_internal_name": {
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "string"
},
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"channel_owner_user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"handler.CreateUser.body": {
"type": "object",
"properties": {
UpdateUser() works
2022-11-18 23:28:37 +01:00
"agent_model": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "string"
},
UpdateUser() works
2022-11-18 23:28:37 +01:00
"agent_version": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "string"
},
UpdateUser() works
2022-11-18 23:28:37 +01:00
"client_type": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "string"
},
UpdateUser() works
2022-11-18 23:28:37 +01:00
"fcm_token": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "string"
},
Added google androidpublisher/v3 api to verify google purchase tokens
2022-11-25 22:42:21 +01:00
"no_client": {
"type": "boolean"
},
UpdateUser() works
2022-11-18 23:28:37 +01:00
"pro_token": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "string"
},
"username": {
"type": "string"
}
}
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"handler.CreateUserKey.body": {
"type": "object",
"required": [
"all_channels",
"channels",
"name",
"permissions"
],
"properties": {
"all_channels": {
"type": "boolean"
},
"channels": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"permissions": {
"type": "string"
}
}
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"handler.DatabaseTest.response": {
"type": "object",
"properties": {
"libVersion": {
"type": "string"
},
"libVersionNumber": {
"type": "integer"
},
"sourceID": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"handler.Expand.response": {
"type": "object",
"properties": {
"data": {
compat methods
2022-11-20 01:28:32 +01:00
"$ref": "#/definitions/models.CompatMessage"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"message": {
"type": "string"
},
"success": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
"handler.Health.response": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
},
"handler.Info.response": {
"type": "object",
"properties": {
"fcm_token_set": {
"type": "boolean"
},
"is_pro": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"message": {
"type": "string"
},
"quota": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"quota_max": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"success": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"unack_count": {
"type": "integer"
},
"user_id": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"user_key": {
"type": "string"
}
}
},
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"handler.ListChannelMessages.response": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/definitions/models.MessageJSON"
}
},
"next_page_token": {
"type": "string"
},
"page_size": {
"type": "integer"
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"handler.ListChannelSubscriptions.response": {
"type": "object",
"properties": {
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/definitions/models.SubscriptionJSON"
}
}
}
},
"handler.ListChannels.response": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"items": {
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
"$ref": "#/definitions/models.ChannelWithSubscriptionJSON"
ListMessages()
2022-11-20 00:19:41 +01:00
}
}
}
},
"handler.ListClients.response": {
ListClients()
2022-11-19 12:47:23 +01:00
"type": "object",
"properties": {
"clients": {
"type": "array",
"items": {
"$ref": "#/definitions/models.ClientJSON"
}
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"handler.ListMessages.response": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/definitions/models.MessageJSON"
}
},
"next_page_token": {
"type": "string"
},
"page_size": {
"type": "integer"
}
}
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"handler.ListUserKeys.response": {
"type": "object",
"properties": {
split api.go into multiple files
2023-05-28 13:39:20 +02:00
"keys": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"type": "array",
"items": {
"$ref": "#/definitions/models.KeyTokenJSON"
}
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"handler.ListUserSubscriptions.response": {
"type": "object",
"properties": {
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/definitions/models.SubscriptionJSON"
}
}
}
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"handler.Register.response": {
"type": "object",
"properties": {
"is_pro": {
re-implement ack behaviour from version 1.0 for compat
2023-02-03 22:51:03 +01:00
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"message": {
"type": "string"
},
"quota": {
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"quota_max": {
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"success": {
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"user_id": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"user_key": {
"type": "string"
}
}
},
"handler.Requery.response": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/models.CompatMessage"
}
},
"message": {
"type": "string"
},
"success": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"handler.SendMessage.combined": {
SendMessage()
2022-11-19 15:13:47 +01:00
"type": "object",
"properties": {
ListMessages()
2022-11-20 00:19:41 +01:00
"channel": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"type": "string",
"example": "test"
ListMessages()
2022-11-20 00:19:41 +01:00
},
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"content": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"type": "string",
"example": "This is a message"
SendMessage()
2022-11-19 15:13:47 +01:00
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"key": {
"type": "string",
"example": "P3TNH8mvv14fm"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"msg_id": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"type": "string",
"example": "db8b0e6a-a08c-4646"
ListMessages()
2022-11-20 00:19:41 +01:00
},
SendMessage()
2022-11-19 15:13:47 +01:00
"priority": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"type": "integer",
"enum": [
0,
1,
2
],
"example": 1
SendMessage()
2022-11-19 15:13:47 +01:00
},
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
"sender_name": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"type": "string",
"example": "example-server"
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
},
ListMessages()
2022-11-20 00:19:41 +01:00
"timestamp": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"type": "number",
"example": 1669824037
ListMessages()
2022-11-20 00:19:41 +01:00
},
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"title": {
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
"type": "string",
"example": "Hello World"
SendMessage()
2022-11-19 15:13:47 +01:00
},
replace PHP in html with js & bugfixes
2022-11-20 03:06:08 +01:00
"user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string",
"example": "7725"
SendMessage()
2022-11-19 15:13:47 +01:00
}
}
},
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
"handler.SendMessage.response": {
"type": "object",
"properties": {
"errhighlight": {
"type": "integer"
},
"error": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"$ref": "#/definitions/apierr.APIError"
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
},
"is_pro": {
"type": "boolean"
},
"message": {
"type": "string"
},
"messagecount": {
"type": "integer"
},
"quota": {
"type": "integer"
},
"quota_max": {
"type": "integer"
},
"scn_msg_id": {
"type": "string"
},
"success": {
"type": "boolean"
},
"suppress_send": {
"type": "boolean"
}
}
},
"handler.SendMessageCompat.response": {
"type": "object",
"properties": {
"errhighlight": {
"type": "integer"
},
"error": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"$ref": "#/definitions/apierr.APIError"
create compat-id for messages && TestCreateCompatUser
2023-01-16 18:53:22 +01:00
},
"is_pro": {
"type": "boolean"
},
"message": {
"type": "string"
},
"messagecount": {
"type": "integer"
},
"quota": {
"type": "integer"
},
"quota_max": {
"type": "integer"
},
"scn_msg_id": {
"type": "integer"
},
"success": {
"type": "boolean"
},
"suppress_send": {
"type": "boolean"
}
}
},
tests (boilerplate)
2022-11-23 20:21:49 +01:00
"handler.Sleep.response": {
"type": "object",
"properties": {
"duration": {
"type": "number"
},
"end": {
"type": "string"
},
"start": {
"type": "string"
}
}
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"handler.Update.response": {
"type": "object",
"properties": {
"is_pro": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"message": {
"type": "string"
},
"quota": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"quota_max": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"success": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"user_id": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"user_key": {
"type": "string"
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
}
},
Tests[ListChannelsDefault, ListChannelsOwned, ListChannelsSubscribedAny, ListChannelsAllAny, ListChannelsSubscribed, ListChannelsAll]
2022-12-22 17:29:59 +01:00
"handler.UpdateSubscription.body": {
"type": "object",
"properties": {
"confirmed": {
"type": "boolean"
}
}
},
split api.go into multiple files
2023-05-28 13:39:20 +02:00
"handler.UpdateUserKey.body": {
"type": "object",
"properties": {
"all_channels": {
"type": "boolean"
},
"channels": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"permissions": {
"type": "string"
}
}
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"handler.Upgrade.response": {
"type": "object",
"properties": {
compat methods
2022-11-20 01:28:32 +01:00
"is_pro": {
"type": "boolean"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"message": {
"type": "string"
},
compat methods
2022-11-20 01:28:32 +01:00
"quota": {
"type": "integer"
},
"quota_max": {
"type": "integer"
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"success": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "boolean"
},
"user_id": {
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
"handler.pingResponse": {
"type": "object",
"properties": {
"info": {
"$ref": "#/definitions/handler.pingResponseInfo"
},
"message": {
"type": "string"
}
}
},
"handler.pingResponseInfo": {
"type": "object",
"properties": {
"addr": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"method": {
"type": "string"
},
"request": {
"type": "string"
},
"uri": {
"type": "string"
}
}
},
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
"models.ChannelWithSubscriptionJSON": {
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "object",
"properties": {
"channel_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
Added freely editable `description_name` field to channel
2023-01-13 12:43:20 +01:00
"description_name": {
"type": "string"
},
Save internal_name and display_name in channel
2022-12-22 11:22:36 +01:00
"display_name": {
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
Save internal_name and display_name in channel
2022-12-22 11:22:36 +01:00
"internal_name": {
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "string"
},
Save internal_name and display_name in channel
2022-12-22 11:22:36 +01:00
"messages_sent": {
"type": "integer"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"owner_user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
"subscribe_key": {
Selector param for ListChannels()
2022-11-20 21:15:06 +01:00
"description": "can be nil, depending on endpoint",
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "string"
},
Added a SQL-Preprocessor - this way we can unmarshal recursive structures (LEFT JOIN etc)
2022-12-21 18:14:13 +01:00
"subscription": {
"$ref": "#/definitions/models.SubscriptionJSON"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"timestamp_created": {
"type": "string"
},
Move sq + ParseDurShortString() to goext and change conf values by env
2022-12-07 23:32:58 +01:00
"timestamp_lastsent": {
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "string"
}
}
},
ListClients()
2022-11-19 12:47:23 +01:00
"models.ClientJSON": {
"type": "object",
"properties": {
"agent_model": {
"type": "string"
},
"agent_version": {
"type": "string"
},
"client_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListClients()
2022-11-19 12:47:23 +01:00
},
"fcm_token": {
"type": "string"
},
"timestamp_created": {
"type": "string"
},
"type": {
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"$ref": "#/definitions/models.ClientType"
ListClients()
2022-11-19 12:47:23 +01:00
},
"user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListClients()
2022-11-19 12:47:23 +01:00
}
}
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"models.ClientType": {
"type": "string",
"enum": [
"ANDROID",
"IOS"
],
"x-enum-varnames": [
"ClientTypeAndroid",
"ClientTypeIOS"
]
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"models.CompatMessage": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"priority": {
"type": "integer"
},
"scn_msg_id": {
compat methods
2022-11-20 01:28:32 +01:00
"type": "integer"
added template for new golang backend
2022-11-13 19:17:07 +01:00
},
"timestamp": {
"type": "integer"
},
"title": {
"type": "string"
},
compat methods
2022-11-20 01:28:32 +01:00
"trimmed": {
"type": "boolean"
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"usr_msg_id": {
"type": "string"
}
}
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"models.KeyTokenJSON": {
"type": "object",
"properties": {
"all_channels": {
"type": "boolean"
},
"channels": {
"type": "array",
"items": {
"type": "string"
}
},
"keytoken_id": {
"type": "string"
},
"messages_sent": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_user_id": {
"type": "string"
},
"permissions": {
"type": "string"
},
"timestamp_created": {
"type": "string"
},
"timestamp_lastused": {
"type": "string"
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"models.MessageJSON": {
"type": "object",
"properties": {
"channel_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
Save internal_name and display_name in channel
2022-12-22 11:22:36 +01:00
"channel_internal_name": {
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "string"
},
Move to own sql abstraction on top of jmoiron/sqlx
2022-12-07 22:11:44 +01:00
"content": {
"type": "string"
},
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"message_id": {
"type": "string"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"owner_user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
"priority": {
"type": "integer"
},
Save SenderName || SenderIP per message
2022-11-29 11:07:15 +01:00
"sender_ip": {
"type": "string"
},
"sender_name": {
"type": "string"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"sender_user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
"timestamp": {
"type": "string"
},
"title": {
"type": "string"
},
"trimmed": {
"type": "boolean"
},
split api.go into multiple files
2023-05-28 13:39:20 +02:00
"used_key_id": {
"type": "string"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"usr_message_id": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"type": "string"
}
}
`POST:/users` works
2022-11-18 21:25:40 +01:00
},
ListMessages()
2022-11-20 00:19:41 +01:00
"models.SubscriptionJSON": {
"type": "object",
"properties": {
"channel_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
Save internal_name and display_name in channel
2022-12-22 11:22:36 +01:00
"channel_internal_name": {
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "string"
},
"channel_owner_user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
"confirmed": {
"type": "boolean"
},
"subscriber_user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
"subscription_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
"timestamp_created": {
"type": "string"
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"models.UserJSON": {
"type": "object",
"properties": {
Use ID types
2022-11-20 22:18:24 +01:00
"default_channel": {
"type": "string"
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"is_pro": {
"type": "boolean"
},
"messages_sent": {
"type": "integer"
},
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"quota_max": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "integer"
CreateUser test
2022-11-24 12:53:27 +01:00
},
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"quota_remaining": {
"type": "integer"
},
"quota_used": {
"type": "integer"
CreateUser test
2022-11-24 12:53:27 +01:00
},
"timestamp_created": {
"type": "string"
},
Move sq + ParseDurShortString() to goext and change conf values by env
2022-12-07 23:32:58 +01:00
"timestamp_lastread": {
CreateUser test
2022-11-24 12:53:27 +01:00
"type": "string"
},
Move sq + ParseDurShortString() to goext and change conf values by env
2022-12-07 23:32:58 +01:00
"timestamp_lastsent": {
CreateUser test
2022-11-24 12:53:27 +01:00
"type": "string"
},
"user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
CreateUser test
2022-11-24 12:53:27 +01:00
},
"username": {
"type": "string"
}
}
},
Add KeyToken authorization
2023-04-21 21:45:16 +02:00
"models.UserJSONWithClientsAndKeys": {
CreateUser test
2022-11-24 12:53:27 +01:00
"type": "object",
"properties": {
"admin_key": {
"type": "string"
},
"clients": {
"type": "array",
"items": {
"$ref": "#/definitions/models.ClientJSON"
}
},
"default_channel": {
"type": "string"
},
"is_pro": {
"type": "boolean"
},
"messages_sent": {
"type": "integer"
},
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"quota_max": {
CreateUser test
2022-11-24 12:53:27 +01:00
"type": "integer"
`POST:/users` works
2022-11-18 21:25:40 +01:00
},
Tests[CreateProUser]
2022-12-14 18:38:30 +01:00
"quota_remaining": {
"type": "integer"
},
"quota_used": {
"type": "integer"
ListMessages()
2022-11-20 00:19:41 +01:00
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"read_key": {
"type": "string"
},
"send_key": {
"type": "string"
},
"timestamp_created": {
"type": "string"
},
Move sq + ParseDurShortString() to goext and change conf values by env
2022-12-07 23:32:58 +01:00
"timestamp_lastread": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "string"
},
Move sq + ParseDurShortString() to goext and change conf values by env
2022-12-07 23:32:58 +01:00
"timestamp_lastsent": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "string"
},
"user_id": {
Move to string-ids for all entities (compat translation for existing data)
2023-01-14 00:48:51 +01:00
"type": "string"
`POST:/users` works
2022-11-18 21:25:40 +01:00
},
"username": {
"type": "string"
}
}
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
tags/grouping for API
2022-11-23 19:32:23 +01:00
},
"tags": [
{
"name": "External"
},
{
"name": "API-v1"
},
{
"name": "API-v2"
Tests[TestSendSimpleMessageJSON]
2022-11-30 17:58:04 +01:00
},
{
"name": "Common"
tags/grouping for API
2022-11-23 19:32:23 +01:00
}
]
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
Copy Permalink