From e7128f0c9792d8b7c6ddbf391c277bd562878fd3 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Thu, 25 Jun 2015 15:58:25 +0200 Subject: API: refine --- api/miniaa.json | 45 ++++++++++++++++++++++++++++++++++----------- 1 file changed, 34 insertions(+), 11 deletions(-) diff --git a/api/miniaa.json b/api/miniaa.json index f0bd702..572e41a 100644 --- a/api/miniaa.json +++ b/api/miniaa.json @@ -2,7 +2,13 @@ "swagger": "2.0", "info": { "version": "1.0.0", - "title": "OpenTox OpenSSO" + "title": "OpenTox OpenSSO Authentication", + "description": "Minimal service to generate and destroy authentication-token.", + "contact": { + "name": "Micha Rautenberg, in silico toxicology", + "url": "http://www.in-silico.ch", + "email": "support@in-silico.ch" + } }, "host": "enm.in-silico.ch", "schemes": [ @@ -11,14 +17,14 @@ "paths": { "/miniaa/authenticate": { "post": { + "tags": [ + "authentication" + ], "description": "Authentication against OpenSSO. Returns token. Requires Username and Password.", "operationId": "login", "consumes": [ "text/plain" ], - "tags": [ - "authentication" - ], "produces": [ "text/plain" ], @@ -41,13 +47,13 @@ ], "responses": { "200": { - "description": "Successful response" + "$ref": "#/responses/200" }, "400": { - "description": "Bad Request" + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" } } } @@ -76,16 +82,33 @@ ], "responses": { "200": { - "description": "Successful response" + "$ref": "#/responses/200" }, "400": { - "description": "Bad Request" + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" } } } } - } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + } + }, + "tags": [ + { + "name": "authentication", + "description": "minimal Authentication service" + } + ] } \ No newline at end of file -- cgit v1.2.3