Mikescher/SimpleCloudNotifier
1
0
Fork 0
Code Pull Requests Actions Releases Activity
b56c021356
SimpleCloudNotifier/server/swagger/swagger.json

2126 lines
72 KiB
JSON
Raw 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",
SendMessage()
2022-11-19 15:13:47 +01:00
"summary": "Send a new message",
"parameters": [
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "chanKey",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "channel",
"in": "query"
},
{
"type": "string",
"name": "content",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "integer",
"name": "priority",
"in": "query"
},
{
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "number",
SendMessage()
2022-11-19 15:13:47 +01:00
"name": "sendTimestamp",
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "title",
"in": "query"
},
{
"type": "integer",
"name": "userID",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "userKey",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "userMessageID",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.SendMessage.body"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/handler.SendMessage.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api-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)",
"summary": "List all (subscribed) messages",
"operationId": "api-messages-list",
"parameters": [
{
"type": "string",
"name": "filter",
"in": "query"
},
{
"type": "string",
"name": "nextPageToken",
"in": "query"
},
{
"type": "integer",
"name": "pageSize",
"in": "query"
},
{
"type": "boolean",
"name": "trimmed",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.ListMessages.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api-v2/messages/{mid}": {
"patch": {
"description": "The user must own the message and request the resource with the ADMIN Key",
"summary": "Delete a single message",
"operationId": "api-messages-delete",
"parameters": [
{
"type": "integer",
"description": "SCNMessageID",
"name": "mid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.MessageJSON"
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"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
ListChannels(), GetChannel(), ListUserSubscriptions(), ListChannelSubscriptions(), GetSubscription(), CancelSubscription()
2022-11-19 17:07:30 +01:00
"/api-v2/users/": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"post": {
"summary": "Create a new user",
"operationId": "api-user-create",
"parameters": [
{
ListMessages()
2022-11-20 00:19:41 +01:00
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.CreateUser.body"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.UserJSON"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api-v2/users/{uid}": {
"get": {
"summary": "Get a user",
"operationId": "api-user-get",
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.UserJSON"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"patch": {
"description": "The body-values are optional, only send the ones you want to update",
"summary": "(Partially) update a user",
"operationId": "api-user-update",
"parameters": [
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.UpdateUser.body"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.UserJSON"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api-v2/users/{uid}/channels": {
"get": {
"summary": "List all channels of a user",
"operationId": "api-channels-list",
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.ListChannels.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api-v2/users/{uid}/channels/{cid}": {
"get": {
"summary": "List all channels of a user",
"operationId": "api-channels-get",
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "ChannelID",
"name": "cid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.ChannelJSON"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
ListChannelMessages()
2022-11-20 00:30:30 +01:00
"/api-v2/users/{uid}/channels/{cid}/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)",
"summary": "List messages of a channel",
"operationId": "api-channel-messages",
"parameters": [
{
"type": "string",
"name": "filter",
"in": "query"
},
{
"type": "string",
"name": "nextPageToken",
"in": "query"
},
{
"type": "integer",
"name": "pageSize",
"in": "query"
},
{
"type": "boolean",
"name": "trimmed",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.ListChannelMessages.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"/api-v2/users/{uid}/channels/{cid}/subscriptions": {
"get": {
"summary": "List all subscriptions of a channel",
"operationId": "api-chan-subscriptions-list",
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "ChannelID",
"name": "cid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.ListChannelSubscriptions.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api-v2/users/{uid}/clients": {
"get": {
"summary": "List all clients",
"operationId": "api-clients-list",
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.ListClients.response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"post": {
"summary": "Delete a client",
"operationId": "api-clients-delete",
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "ClientID",
"name": "cid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.ClientJSON"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
"/api-v2/users/{uid}/clients/{cid}": {
"get": {
"summary": "Get a single clients",
"operationId": "api-clients-get",
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "ClientID",
"name": "cid",
"in": "path",
"required": true
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/models.ClientJSON"
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"/api-v2/users/{uid}/subscriptions": {
UpdateUser() works
2022-11-18 23:28:37 +01:00
"get": {
ListMessages()
2022-11-20 00:19:41 +01:00
"summary": "List all channels of a user",
"operationId": "api-user-subscriptions-list",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/handler.ListUserSubscriptions.response"
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"post": {
"summary": "Creare/Request a subscription",
"operationId": "api-subscriptions-create",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"parameters": [
ListMessages()
2022-11-20 00:19:41 +01:00
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "string",
"name": "chanSubscribeKey",
"in": "query"
},
UpdateUser() works
2022-11-18 23:28:37 +01:00
{
"description": " ",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "post_data",
UpdateUser() works
2022-11-18 23:28:37 +01:00
"in": "body",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/handler.CreateSubscription.body"
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"/api-v2/users/{uid}/subscriptions/{sid}": {
ListClients()
2022-11-19 12:47:23 +01:00
"get": {
ListMessages()
2022-11-20 00:19:41 +01:00
"summary": "Get a single subscription",
"operationId": "api-subscriptions-get",
ListClients()
2022-11-19 12:47:23 +01:00
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
ListMessages()
2022-11-20 00:19:41 +01:00
},
{
"type": "integer",
"description": "SubscriptionID",
"name": "sid",
"in": "path",
"required": true
ListClients()
2022-11-19 12:47:23 +01:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
ListClients()
2022-11-19 12:47:23 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
GetClient()
2022-11-19 12:50:41 +01:00
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
DeleteClient()
2022-11-19 12:59:25 +01:00
},
ListMessages()
2022-11-20 00:19:41 +01:00
"delete": {
"summary": "Cancel (delete) subscription",
"operationId": "api-subscriptions-delete",
DeleteClient()
2022-11-19 12:59:25 +01:00
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
ListMessages()
2022-11-20 00:19:41 +01:00
"description": "SubscriptionID",
"name": "sid",
DeleteClient()
2022-11-19 12:59:25 +01:00
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
DeleteClient()
2022-11-19 12:59:25 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
ListMessages()
2022-11-20 00:19:41 +01:00
},
"patch": {
"summary": "Update a subscription (e.g. confirm)",
"operationId": "api-subscriptions-update",
GetClient()
2022-11-19 12:50:41 +01:00
"parameters": [
{
"type": "integer",
"description": "UserID",
"name": "uid",
"in": "path",
"required": true
},
{
"type": "integer",
ListMessages()
2022-11-20 00:19:41 +01:00
"description": "SubscriptionID",
"name": "sid",
GetClient()
2022-11-19 12:50:41 +01:00
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/models.SubscriptionJSON"
GetClient()
2022-11-19 12:50:41 +01:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
ListClients()
2022-11-19 12:47:23 +01:00
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/api/ack.php": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"get": {
"summary": "Acknowledge that a message was received",
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"operationId": "compat-ack",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"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
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Ack.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"$ref": "#/definitions/ginresp.apiError"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/api/expand.php": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"get": {
"summary": "Get a whole (potentially truncated) message",
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"operationId": "compat-expand",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Expand.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"$ref": "#/definitions/ginresp.apiError"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/api/info.php": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"get": {
"summary": "Get information about the current user",
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"operationId": "compat-info",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"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
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Info.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"$ref": "#/definitions/ginresp.apiError"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/api/register.php": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"get": {
"summary": "Register a new account",
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"operationId": "compat-register",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"parameters": [
{
"type": "string",
"description": "the (android) fcm token",
"name": "fcm_token",
"in": "query",
"required": true
},
{
"enum": [
"true",
"false"
],
"type": "string",
"description": "if the user is a paid account",
"name": "pro",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the (android) IAP token",
"name": "pro_token",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Register.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"$ref": "#/definitions/ginresp.apiError"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/api/requery.php": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"get": {
"summary": "Return all not-acknowledged messages",
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"operationId": "compat-requery",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"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
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Requery.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"$ref": "#/definitions/ginresp.apiError"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/api/update.php": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"get": {
"summary": "Set the fcm-token (android)",
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"operationId": "compat-update",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"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 (android) fcm token",
"name": "fcm_token",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Update.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"$ref": "#/definitions/ginresp.apiError"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/api/upgrade.php": {
added template for new golang backend
2022-11-13 19:17:07 +01:00
"get": {
"summary": "Upgrade a free account to a paid account",
implement a bit of the register.php call (and the DB schema)
2022-11-13 22:31:28 +01:00
"operationId": "compat-upgrade",
added template for new golang backend
2022-11-13 19:17:07 +01:00
"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
},
{
"enum": [
"true",
"false"
],
"type": "string",
"description": "if the user is a paid account",
"name": "pro",
"in": "query",
"required": true
},
{
"type": "string",
"description": "the (android) IAP token",
"name": "pro_token",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Upgrade.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"$ref": "#/definitions/ginresp.apiError"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
}
`POST:/users` works
2022-11-18 21:25:40 +01:00
},
"/db-test": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.DatabaseTest.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/health": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.Health.response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"/ping": {
"get": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.pingResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"put": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.pingResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"post": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.pingResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"delete": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.pingResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
},
"patch": {
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.pingResponse"
}
},
"500": {
"description": "Internal Server Error",
"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",
SendMessage()
2022-11-19 15:13:47 +01:00
"summary": "Send a new message",
"parameters": [
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "chanKey",
"in": "query"
},
{
"type": "string",
"name": "channel",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "content",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "integer",
"name": "priority",
"in": "query"
},
{
ListMessages()
2022-11-20 00:19:41 +01:00
"type": "number",
SendMessage()
2022-11-19 15:13:47 +01:00
"name": "sendTimestamp",
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "title",
"in": "query"
},
{
"type": "integer",
"name": "userID",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "userKey",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"type": "string",
ListMessages()
2022-11-20 00:19:41 +01:00
"name": "userMessageID",
SendMessage()
2022-11-19 15:13:47 +01:00
"in": "query"
},
{
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"$ref": "#/definitions/handler.SendMessage.body"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
ListMessages()
2022-11-20 00:19:41 +01:00
"$ref": "#/definitions/handler.SendMessage.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
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ginresp.apiError"
}
}
}
}
`POST:/users` works
2022-11-18 21:25:40 +01:00
}
},
"definitions": {
"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"
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"errorObject": {},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"message": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"handler.Ack.response": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"new_ack": {
"type": "integer"
},
"prev_ack": {
"type": "integer"
},
"success": {
"type": "string"
}
}
},
DeleteClient()
2022-11-19 12:59:25 +01:00
"handler.AddClient.body": {
"type": "object",
"properties": {
"agent_model": {
"type": "string"
},
"agent_version": {
"type": "string"
},
"client_type": {
"type": "string"
},
"fcm_token": {
"type": "string"
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"handler.CreateSubscription.body": {
"type": "object",
"properties": {
"channel": {
"type": "string"
},
"channelOwnerUserID": {
"type": "integer"
}
}
},
`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"
},
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"
}
}
},
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": {
"$ref": "#/definitions/models.ShortCompatMessage"
},
"message": {
"type": "string"
},
"success": {
"type": "string"
}
}
},
"handler.Health.response": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
},
"handler.Info.response": {
"type": "object",
"properties": {
"fcm_token_set": {
"type": "boolean"
},
"is_pro": {
"type": "string"
},
"message": {
"type": "string"
},
"quota": {
"type": "string"
},
"quota_max": {
"type": "string"
},
"success": {
"type": "string"
},
"unack_count": {
"type": "integer"
},
"user_id": {
"type": "string"
},
"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": {
"$ref": "#/definitions/models.ChannelJSON"
}
}
}
},
"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"
}
}
},
"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": {
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
},
"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": {
"type": "string"
},
"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": {
"type": "string"
}
}
},
SendMessage()
2022-11-19 15:13:47 +01:00
"handler.SendMessage.body": {
"type": "object",
"properties": {
ListMessages()
2022-11-20 00:19:41 +01:00
"chanKey": {
"type": "string"
},
"channel": {
"type": "string"
},
SendMessage()
2022-11-19 15:13:47 +01:00
"message_content": {
"type": "string"
},
"message_title": {
"type": "string"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"msg_id": {
"type": "string"
},
SendMessage()
2022-11-19 15:13:47 +01:00
"priority": {
"type": "integer"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"timestamp": {
"type": "number"
},
"user_id": {
SendMessage()
2022-11-19 15:13:47 +01:00
"type": "integer"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"user_key": {
SendMessage()
2022-11-19 15:13:47 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
}
}
},
"handler.SendMessage.response": {
"type": "object",
"properties": {
"errhighlight": {
"type": "integer"
SendMessage()
2022-11-19 15:13:47 +01:00
},
ListMessages()
2022-11-20 00:19:41 +01:00
"error": {
"type": "integer"
SendMessage()
2022-11-19 15:13:47 +01:00
},
ListMessages()
2022-11-20 00:19:41 +01:00
"is_pro": {
"type": "boolean"
},
"message": {
SendMessage()
2022-11-19 15:13:47 +01:00
"type": "string"
ListMessages()
2022-11-20 00:19:41 +01:00
},
"messagecount": {
"type": "integer"
},
"quota": {
"type": "integer"
},
"quota_max": {
"type": "integer"
},
"scn_msg_id": {
"type": "integer"
},
"success": {
"type": "boolean"
},
"suppress_send": {
"type": "boolean"
SendMessage()
2022-11-19 15:13:47 +01:00
}
}
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"handler.Update.response": {
"type": "object",
"properties": {
"is_pro": {
"type": "string"
},
"message": {
"type": "string"
},
"quota": {
"type": "string"
},
"quota_max": {
"type": "string"
},
"success": {
"type": "string"
},
"user_id": {
"type": "string"
},
"user_key": {
"type": "string"
UpdateUser() works
2022-11-18 23:28:37 +01:00
}
}
},
"handler.UpdateUser.body": {
"type": "object",
"properties": {
"pro_token": {
"type": "string"
},
"username": {
"type": "string"
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
},
"handler.Upgrade.response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/models.ShortCompatMessage"
},
"message": {
"type": "string"
},
"success": {
"type": "string"
}
}
},
"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"
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"models.ChannelJSON": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer"
},
"messages_sent": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_user_id": {
"type": "integer"
},
"send_key": {
"type": "string"
},
"subscribe_key": {
"type": "string"
},
"timestamp_created": {
"type": "string"
},
"timestamp_last_sent": {
"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": {
"type": "integer"
},
"fcm_token": {
"type": "string"
},
"timestamp_created": {
"type": "string"
},
"type": {
"type": "string"
},
"user_id": {
"type": "integer"
}
}
},
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": {
"type": "string"
},
"timestamp": {
"type": "integer"
},
"title": {
"type": "string"
},
"usr_msg_id": {
"type": "string"
}
}
},
ListMessages()
2022-11-20 00:19:41 +01:00
"models.MessageJSON": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"channel_id": {
"type": "integer"
},
"channel_name": {
"type": "string"
},
"owner_user_id": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"scn_message_id": {
"type": "integer"
},
"sender_user_id": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"title": {
"type": "string"
},
"trimmed": {
"type": "boolean"
},
"usr_message_id": {
"type": "string"
}
}
},
added template for new golang backend
2022-11-13 19:17:07 +01:00
"models.ShortCompatMessage": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"priority": {
"type": "integer"
},
"scn_msg_id": {
"type": "string"
},
"timestamp": {
"type": "integer"
},
"title": {
"type": "string"
},
"trimmed": {
"type": "boolean"
},
"usr_msg_id": {
"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": {
"type": "integer"
},
"channel_name": {
"type": "string"
},
"channel_owner_user_id": {
"type": "integer"
},
"confirmed": {
"type": "boolean"
},
"subscriber_user_id": {
"type": "integer"
},
"subscription_id": {
"type": "integer"
},
"timestamp_created": {
"type": "string"
}
}
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"models.UserJSON": {
"type": "object",
"properties": {
"admin_key": {
"type": "string"
},
"is_pro": {
"type": "boolean"
},
"messages_sent": {
"type": "integer"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"quota_used": {
`POST:/users` works
2022-11-18 21:25:40 +01:00
"type": "integer"
},
ListMessages()
2022-11-20 00:19:41 +01:00
"quota_used_day": {
"type": "string"
},
`POST:/users` works
2022-11-18 21:25:40 +01:00
"read_key": {
"type": "string"
},
"send_key": {
"type": "string"
},
"timestamp_created": {
"type": "string"
},
"timestamp_last_read": {
"type": "string"
},
"timestamp_last_sent": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"username": {
"type": "string"
}
}
added template for new golang backend
2022-11-13 19:17:07 +01:00
}
}
}
Copy Permalink