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

implement a bit of the register.php call (and the DB schema)

Browse Source
This commit is contained in:
Mike Schwörer
2022-11-13 22:31:28 +01:00
parent 0e58a5c5f0
commit 1671490485
13 changed files with 460 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
server/swagger/swagger.json
View File

@@ -12,6 +12,7 @@
"/ack.php": {
"get": {
"summary": "Acknowledge that a message was received",
"operationId": "compat-ack",
"parameters": [
{
"type": "string",
@@ -72,6 +73,7 @@
"/expand.php": {
"get": {
"summary": "Get a whole (potentially truncated) message",
"operationId": "compat-expand",
"responses": {
"200": {
"description": "OK",
@@ -109,6 +111,7 @@
"/info.php": {
"get": {
"summary": "Get information about the current user",
"operationId": "compat-info",
"parameters": [
{
"type": "string",
@@ -226,6 +229,7 @@
"/register.php": {
"get": {
"summary": "Register a new account",
"operationId": "compat-register",
"parameters": [
{
"type": "string",
@@ -272,6 +276,7 @@
"/requery.php": {
"get": {
"summary": "Return all not-acknowledged messages",
"operationId": "compat-requery",
"parameters": [
{
"type": "string",
@@ -306,111 +311,57 @@
},
"/send.php": {
"post": {
"description": "all aeguments can either be supplied in the query or in the json body",
"description": "(all arguments can either be supplied in the query or in the json body)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Send a message",
"operationId": "compat-send",
"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 title",
"name": "title",
"in": "query",
"required": true
},
{
"type": "string",
"description": "The message content",
"name": "content",
"in": "query"
},
{
"type": "string",
"description": "The message priority",
"name": "messageID",
"in": "query"
},
{
"type": "string",
"name": "priority",
"in": "query"
},
{
"type": "string",
"description": "The message idempotency id",
"name": "msg_id",
"in": "query"
},
{
"type": "string",
"description": "The message timestamp",
"name": "timestamp",
"in": "query"
},
{
"description": "the user_id",
"name": "user_id",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "the user_key",
"name": "user_key",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The message title",
"type": "string",
"name": "title",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
"in": "query"
},
{
"description": "The message content",
"name": "content",
"in": "body",
"schema": {
"type": "string"
}
"type": "string",
"name": "userID",
"in": "query"
},
{
"description": "The message priority",
"name": "priority",
"in": "body",
"schema": {
"type": "string"
}
"type": "string",
"name": "userKey",
"in": "query"
},
{
"description": "The message idempotency id",
"name": "msg_id",
"description": " ",
"name": "post_body",
"in": "body",
"schema": {
"type": "string"
}
},
{
"description": "The message timestamp",
"name": "timestamp",
"in": "body",
"schema": {
"type": "string"
"$ref": "#/definitions/handler.Send.body"
}
}
],
@@ -433,6 +384,7 @@
"/update.php": {
"get": {
"summary": "Set the fcm-token (android)",
"operationId": "compat-update",
"parameters": [
{
"type": "string",
@@ -475,6 +427,7 @@
"/upgrade.php": {
"get": {
"summary": "Upgrade a free account to a paid account",
"operationId": "compat-upgrade",
"parameters": [
{
"type": "string",
@@ -661,19 +614,19 @@
"type": "object",
"properties": {
"is_pro": {
"type": "string"
"type": "integer"
},
"message": {
"type": "string"
},
"quota": {
"type": "string"
"type": "integer"
},
"quota_max": {
"type": "string"
"type": "integer"
},
"success": {
"type": "string"
"type": "boolean"
},
"user_id": {
"type": "string"
@@ -703,6 +656,32 @@
}
}
},
"handler.Send.body": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"msg_id": {
"type": "string"
},
"priority": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"title": {
"type": "string"
},
"user_id": {
"type": "string"
},
"user_key": {
"type": "string"
}
}
},
"handler.Send.response": {
"type": "object",
"properties": {

118
server/swagger/swagger.yaml
View File

@@ -87,15 +87,15 @@ definitions:
handler.Register.response:
properties:
is_pro:
type: string
type: integer
message:
type: string
quota:
type: string
type: integer
quota_max:
type: string
type: integer
success:
type: string
type: boolean
user_id:
type: string
user_key:
@@ -114,6 +114,23 @@ definitions:
success:
type: string
type: object
handler.Send.body:
properties:
content:
type: string
msg_id:
type: string
priority:
type: string
timestamp:
type: string
title:
type: string
user_id:
type: string
user_key:
type: string
type: object
handler.Send.response:
properties:
message:
@@ -212,6 +229,7 @@ info:
paths:
/ack.php:
get:
operationId: compat-ack
parameters:
- description: the user_id
in: query
@@ -251,6 +269,7 @@ paths:
$ref: '#/definitions/ginresp.errBody'
/expand.php:
get:
operationId: compat-expand
responses:
"200":
description: OK
@@ -274,6 +293,7 @@ paths:
$ref: '#/definitions/ginresp.errBody'
/info.php:
get:
operationId: compat-info
parameters:
- description: the user_id
in: query
@@ -348,6 +368,7 @@ paths:
$ref: '#/definitions/ginresp.errBody'
/register.php:
get:
operationId: compat-register
parameters:
- description: the (android) fcm token
in: query
@@ -379,6 +400,7 @@ paths:
summary: Register a new account
/requery.php:
get:
operationId: compat-requery
parameters:
- description: the user_id
in: query
@@ -402,78 +424,40 @@ paths:
summary: Return all not-acknowledged messages
/send.php:
post:
description: all aeguments can either be supplied in the query or in the json
body
consumes:
- application/json
description: (all arguments can either be supplied in the query or in the json
body)
operationId: compat-send
parameters:
- description: the user_id
in: query
name: user_id
required: true
type: string
- description: the user_key
in: query
name: user_key
required: true
type: string
- description: The message title
in: query
name: title
required: true
type: string
- description: The message content
in: query
- in: query
name: content
type: string
- description: The message priority
in: query
- in: query
name: messageID
type: string
- in: query
name: priority
type: string
- description: The message idempotency id
in: query
name: msg_id
type: string
- description: The message timestamp
in: query
- in: query
name: timestamp
type: string
- description: the user_id
in: body
name: user_id
required: true
schema:
type: string
- description: the user_key
in: body
name: user_key
required: true
schema:
type: string
- description: The message title
in: body
- in: query
name: title
required: true
schema:
type: string
- description: The message content
type: string
- in: query
name: userID
type: string
- in: query
name: userKey
type: string
- description: ' '
in: body
name: content
name: post_body
schema:
type: string
- description: The message priority
in: body
name: priority
schema:
type: string
- description: The message idempotency id
in: body
name: msg_id
schema:
type: string
- description: The message timestamp
in: body
name: timestamp
schema:
type: string
$ref: '#/definitions/handler.Send.body'
produces:
- application/json
responses:
"200":
description: OK
@@ -486,6 +470,7 @@ paths:
summary: Send a message
/update.php:
get:
operationId: compat-update
parameters:
- description: the user_id
in: query
@@ -514,6 +499,7 @@ paths:
summary: Set the fcm-token (android)
/upgrade.php:
get:
operationId: compat-upgrade
parameters:
- description: the user_id
in: query