{ "openapi": "3.0.4", "info": { "title": "MiracleList API", "description": "Backend for MiracleList.de with token in HTTP header", "contact": { "name": "Holger Schwichtenberg", "url": "http://it-visions.de/kontakt", "email": "" }, "version": "v2" }, "paths": { "/v2/About": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Informationen über den Server", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v2/Version": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Liefert die Version des Servers als Zeichenkette", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/v2/Login": { "post": { "tags": [ "MiracleListApiV2" ], "summary": "Login with a client ID, username and password. This operation / login sends back a GUID as a session token, to be used in all following operations.", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } } } } } } }, "/v2/Logoff": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Delete token", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/v2/CategorySet": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Get a list of all categories", "parameters": [ { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } } }, "/v2/TaskSet/{categoryId}": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Get a list of tasks in one category", "parameters": [ { "name": "categoryId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } } } } } } }, "/v2/Task/{id}": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Get details of one task", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/v2/Search/{text}": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Search in tasks and subtasks", "parameters": [ { "name": "text", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } } }, "/v2/DueTaskSet": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Returns all tasks due, including tomorrow, grouped by category, sorted by date", "parameters": [ { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } } }, "/v2/CreateCategory/{name}": { "post": { "tags": [ "MiracleListApiV2" ], "summary": "Create a new category", "parameters": [ { "name": "name", "in": "path", "description": "name of new category", "required": true, "schema": { "type": "string" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Category" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Category" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Category" } } } } } } }, "/v2/CreateTask": { "post": { "tags": [ "MiracleListApiV2" ], "summary": "Create a task to be submitted in body in JSON format (including subtasks)", "parameters": [ { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/v2/ChangeTask": { "put": { "tags": [ "MiracleListApiV2" ], "summary": "Change a task to be submitted in body in JSON format (including subtasks)", "parameters": [ { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/v2/ChangeTaskOrder": { "put": { "tags": [ "MiracleListApiV2" ], "summary": "Change a task to be submitted in body in JSON format (including subtasks)", "parameters": [ { "name": "categoryID", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v2/ChangeTaskDone": { "put": { "tags": [ "MiracleListApiV2" ], "summary": "Set a task to \"done\"", "parameters": [ { "name": "id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "done", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Task" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Task" } } } } } } }, "/v2/ChangeSubTask": { "put": { "tags": [ "MiracleListApiV2" ], "summary": "Change a subtask", "parameters": [ { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SubTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubTask" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubTask" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubTask" } } } } } } }, "/v2/DeleteTask/{id}": { "delete": { "tags": [ "MiracleListApiV2" ], "summary": "Delete a task with all subtasks", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v2/DeleteCategory/{id}": { "delete": { "tags": [ "MiracleListApiV2" ], "summary": "Delete a category with all tasks and subtasks", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v2/Task/{id}/Upload": { "post": { "tags": [ "MiracleListApiV2" ], "summary": "File Upload", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/v2/Task/{id}/Filelist": { "get": { "tags": [ "MiracleListApiV2" ], "summary": "Get list of files for a Task", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FileInfoDTO" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FileInfoDTO" } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FileInfoDTO" } } } } } } } }, "/v2/Task/{id}/File/{name}": { "delete": { "tags": [ "MiracleListApiV2" ], "summary": "Delete a file", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ML-AuthToken", "in": "header", "description": "Access Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } } }, "components": { "schemas": { "Category": { "type": "object", "properties": { "categoryID": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "taskSet": { "type": "array", "items": { "$ref": "#/components/schemas/Task" }, "nullable": true }, "user": { "$ref": "#/components/schemas/User" }, "userID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Client": { "type": "object", "properties": { "clientID": { "type": "string", "format": "uuid" }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "company": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "eMail": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "deleted": { "type": "string", "format": "date-time", "nullable": true }, "memo": { "type": "string", "nullable": true }, "type": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "userSet": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "nullable": true } }, "additionalProperties": false }, "FileInfoDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "relPath": { "type": "string", "nullable": true }, "length": { "type": "integer", "format": "int64" }, "lastWriteTime": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Importance": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enumNames": [ "A", "B", "C" ] }, "LoginInfo": { "type": "object", "properties": { "clientID": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "DTO wird verwendet als Ein- + Ausgabe für Login-Operation\r\nAchtung: Hier waren früher Fields statt Properties. Das mag aber Swagger nicht mehr :-(" }, "SubTask": { "type": "object", "properties": { "subTaskID": { "type": "integer", "format": "int32" }, "title": { "maxLength": 250, "type": "string", "nullable": true }, "done": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "task": { "$ref": "#/components/schemas/Task" }, "taskID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Task": { "required": [ "title" ], "type": "object", "properties": { "taskID": { "type": "integer", "format": "int32" }, "title": { "maxLength": 250, "minLength": 3, "type": "string" }, "created": { "type": "string", "format": "date-time" }, "due": { "type": "string", "format": "date-time", "nullable": true }, "importance": { "$ref": "#/components/schemas/Importance" }, "note": { "type": "string", "nullable": true }, "done": { "type": "boolean" }, "effort": { "type": "number", "format": "double", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "dueInDays": { "type": "integer", "format": "int32", "nullable": true }, "subTaskSet": { "type": "array", "items": { "$ref": "#/components/schemas/SubTask" }, "nullable": true }, "categoryID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "userID": { "type": "integer", "format": "int32" }, "userGUID": { "type": "string", "format": "uuid" }, "userName": { "type": "string", "nullable": true }, "passwordHash": { "type": "string", "nullable": true }, "token": { "maxLength": 38, "minLength": 0, "type": "string", "nullable": true }, "salt": { "type": "string", "format": "byte", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "lastActivity": { "type": "string", "format": "date-time", "nullable": true }, "deactivated": { "type": "string", "format": "date-time", "nullable": true }, "memo": { "type": "string", "nullable": true }, "maxTasks": { "type": "integer", "format": "int32", "nullable": true }, "categorySet": { "type": "array", "items": { "$ref": "#/components/schemas/Category" }, "nullable": true }, "client": { "$ref": "#/components/schemas/Client" }, "clientID": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false } } } }