colin
/
sharded-gotify
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Spec

This commit is contained in:
Jannis Mattheis 2018-03-10 22:06:22 +01:00 committed by Jannis Mattheis
parent fb972ec9a6
commit c07dc59af9
1 changed files with 31 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/spec.json
View File

@ -151,7 +151,7 @@
"operationId": "deleteApp", "operationId": "deleteApp",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "integer",
"description": "the application id", "description": "the application id",
"name": "id", "name": "id",
"in": "path", "in": "path",
@ -200,7 +200,7 @@
"operationId": "getAppMessages", "operationId": "getAppMessages",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "integer",
"description": "the application id", "description": "the application id",
"name": "id", "name": "id",
"in": "path", "in": "path",
@ -253,7 +253,7 @@
"operationId": "deleteAppMessages", "operationId": "deleteAppMessages",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "integer",
"description": "the application id", "description": "the application id",
"name": "id", "name": "id",
"in": "path", "in": "path",
@ -409,7 +409,7 @@
"operationId": "deleteClient", "operationId": "deleteClient",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "integer",
"description": "the client id", "description": "the client id",
"name": "id", "name": "id",
"in": "path", "in": "path",
@ -1051,6 +1051,7 @@
"title": "Application Model", "title": "Application Model",
"required": [ "required": [
"id", "id",
"token",
"name", "name",
"description" "description"
], ],
@ -1062,17 +1063,25 @@
"example": "Backup server for the interwebs" "example": "Backup server for the interwebs"
}, },
"id": { "id": {
"description": "The application id. Can be used as `appToken`. See Authentication.", "description": "The application id.",
"type": "string", "type": "integer",
"format": "uint64",
"x-go-name": "ID", "x-go-name": "ID",
"readOnly": true, "readOnly": true,
"example": "AWH0wZ5r0Mbac.r" "example": 5
}, },
"name": { "name": {
"description": "The application name. This is how the application should be displayed to the user.", "description": "The application name. This is how the application should be displayed to the user.",
"type": "string", "type": "string",
"x-go-name": "Name", "x-go-name": "Name",
"example": "Backup Server" "example": "Backup Server"
},
"token": {
"description": "The application token. Can be used as `appToken`. See Authentication.",
"type": "string",
"x-go-name": "Token",
"readOnly": true,
"example": "AWH0wZ5r0Mbac.r"
} }
}, },
"x-go-package": "github.com/gotify/server/model" "x-go-package": "github.com/gotify/server/model"
@ -1083,21 +1092,30 @@
"title": "Client Model", "title": "Client Model",
"required": [ "required": [
"id", "id",
"token",
"name" "name"
], ],
"properties": { "properties": {
"id": { "id": {
"description": "The client id. Can be used as `clientToken`. See Authentication.", "description": "The client id.",
"type": "string", "type": "integer",
"format": "uint64",
"x-go-name": "ID", "x-go-name": "ID",
"readOnly": true, "readOnly": true,
"example": "CWH0wZ5r0Mbac.r" "example": 5
}, },
"name": { "name": {
"description": "The client name. This is how the client should be displayed to the user.", "description": "The client name. This is how the client should be displayed to the user.",
"type": "string", "type": "string",
"x-go-name": "Name", "x-go-name": "Name",
"example": "Android Phone" "example": "Android Phone"
},
"token": {
"description": "The client token. Can be used as `clientToken`. See Authentication.",
"type": "string",
"x-go-name": "Token",
"readOnly": true,
"example": "CWH0wZ5r0Mbac.r"
} }
}, },
"x-go-package": "github.com/gotify/server/model" "x-go-package": "github.com/gotify/server/model"
@ -1148,10 +1166,11 @@
"properties": { "properties": {
"appid": { "appid": {
"description": "The application id that send this message.", "description": "The application id that send this message.",
"type": "string", "type": "integer",
"format": "uint64",
"x-go-name": "ApplicationID", "x-go-name": "ApplicationID",
"readOnly": true, "readOnly": true,
"example": "AWH0wZ5r0Mbac.r" "example": 5
}, },
"date": { "date": {
"description": "The date the message was created.", "description": "The date the message was created.",