openapi: add gitlab integration endpoints

addresses reanahub/reana-server#175
reanahub · Dec 3, 2019 · 40dac59 · 40dac59
1 parent 3eb59e7
commit 40dac59
Showing 1 changed file with 61 additions and 0 deletions.
diff --git a/reana_commons/openapi_specifications/reana_server.json b/reana_commons/openapi_specifications/reana_server.json
@@ -76,6 +76,18 @@
         "summary": "Get access token from GitLab"
       }
     },
+    "/api/gitlab/connect": {
+      "get": {
+        "description": "Initiate connection to GitLab to authorize accessing the authenticated user's API.",
+        "operationId": "gitlab_connect",
+        "responses": {
+          "302": {
+            "description": "Redirection to GitLab site."
+          }
+        },
+        "summary": "Initiate connection to GitLab."
+      }
+    },
     "/api/gitlab/projects": {
       "get": {
         "description": "Retrieve projects from GitLab.",
@@ -156,6 +168,55 @@
         "summary": "TEMPORARY displays a message about how to access a resource."
       }
     },
+    "/api/logout": {},
+    "/api/me": {
+      "get": {
+        "description": "This resource provides basic information about an authenticated user based on the session cookie presence.",
+        "operationId": "get_me",
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "User information correspoding to the session cookie sent in the request.",
+            "examples": {
+              "application/json": {
+                "email": "user@reana.info",
+                "reana_token": "Drmhze6EPcv0fN_81Bj-nA"
+              }
+            },
+            "schema": {
+              "properties": {
+                "email": {
+                  "type": "string"
+                },
+                "reana_token": {
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "401": {
+            "description": "Error message indicating that the uses is not authenticated.",
+            "examples": {
+              "application/json": {
+                "error": "User not logged in"
+              }
+            },
+            "schema": {
+              "properties": {
+                "error": {
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            }
+          }
+        },
+        "summary": "Gets information about authenticated user."
+      }
+    },
     "/api/ping": {
       "get": {
         "description": "Ping the server.",