From 2c05a1ccc18a9f868dce26bdd62fd95163dc4f9c Mon Sep 17 00:00:00 2001 From: Miodec Date: Mon, 28 Feb 2022 19:53:07 +0100 Subject: [PATCH] added basic swagger spec part of #2605 --- backend/swagger.json | 50 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 backend/swagger.json diff --git a/backend/swagger.json b/backend/swagger.json new file mode 100644 index 000000000..9c2b3a21e --- /dev/null +++ b/backend/swagger.json @@ -0,0 +1,50 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0.0", + "title": "Monkeytype", + "termsOfService": "http://monkeytype.com/terms-of-service", + "contact": { + "name": "Developer", + "email": "jack@monkeytype.com" + } + }, + "host": "api.monkeytype.com", + "basePath": "/", + "schemes": ["https"], + "consumes": ["application/json"], + "produces": ["application/json"], + "paths": { + "/users": { + "get": { + "description": "Returns user data", + "produces": ["application/json"], + "responses": { + "200": { + "description": "User data.", + "schema": { + "$ref": "#/definitions/Response" + } + } + } + } + } + }, + "definitions": { + "Response": { + "type": "object", + "required": ["error", "message", "data"], + "properties": { + "error": { + "type": "string" + }, + "message": { + "type": "string" + }, + "data": { + "type": "object" + } + } + } + } +}