From 9007c2bee8108714dab57cf03feebf5ec563b349 Mon Sep 17 00:00:00 2001 From: Alputer Date: Mon, 27 May 2024 11:24:34 +0200 Subject: [PATCH] docs(info): add recommended images to info endpoint (#459) --- .../openapi_specifications/reana_server.json | 100 +++++++++++++++++- 1 file changed, 98 insertions(+), 2 deletions(-) diff --git a/reana_commons/openapi_specifications/reana_server.json b/reana_commons/openapi_specifications/reana_server.json index 3001071d..44ff2d15 100644 --- a/reana_commons/openapi_specifications/reana_server.json +++ b/reana_commons/openapi_specifications/reana_server.json @@ -2,7 +2,7 @@ "info": { "description": "Submit workflows to be run on REANA Cloud", "title": "REANA Server", - "version": "0.9.1a3" + "version": "0.95.0a1" }, "paths": { "/account/settings/linkedaccounts/": {}, @@ -148,12 +148,87 @@ "get": { "description": "Retrieve projects from GitLab.", "operationId": "gitlab_projects", + "parameters": [ + { + "description": "The API access_token of the current user.", + "in": "query", + "name": "access_token", + "required": false, + "type": "string" + }, + { + "description": "The search string to filter the project list.", + "in": "query", + "name": "search", + "required": false, + "type": "string" + }, + { + "description": "Results page number (pagination).", + "in": "query", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Number of results per page (pagination).", + "in": "query", + "name": "size", + "required": false, + "type": "integer" + } + ], "produces": [ "application/json" ], "responses": { "200": { - "description": "This resource return all projects owned by the user on GitLab in JSON format." + "description": "This resource return all projects owned by the user on GitLab in JSON format.", + "schema": { + "properties": { + "has_next": { + "type": "boolean" + }, + "has_prev": { + "type": "boolean" + }, + "items": { + "items": { + "properties": { + "hook_id": { + "type": "integer", + "x-nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "page": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "total": { + "type": "integer", + "x-nullable": true + } + }, + "type": "object" + } }, "403": { "description": "Request failed. User token not valid.", @@ -366,6 +441,13 @@ "title": "Default workspace", "value": "/usr/share" }, + "interactive_session_recommended_jupyter_images": { + "title": "Recommended jupyter images for interactive sessions", + "value": [ + "docker.io/jupyter/scipy-notebook:notebook-6.4.5", + "docker.io/jupyter/scipy-notebook:notebook-9.4.5" + ] + }, "kubernetes_max_memory_limit": { "title": "Maximum allowed memory limit for Kubernetes jobs", "value": "10Gi" @@ -441,6 +523,20 @@ }, "type": "object" }, + "interactive_session_recommended_jupyter_images": { + "properties": { + "title": { + "type": "string" + }, + "value": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "kubernetes_max_memory_limit": { "properties": { "title": {