Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Server side validation #468

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Server side validation #468

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb6de1a
wip
wirespecter Aug 16, 2024
486d850
wip
wirespecter Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 144 additions & 6 deletions reana_commons/openapi_specifications/reana_server.json
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,11 @@
"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/": {},
"/account/settings/linkedaccounts/static/{filename}": {},
"/account/settings/login": {},
"/account/settings/security/": {},
"/account/settings/sessions/revoke/": {},
"/account/settings/static/{filename}": {},
"/api/config": {
"get": {
"description": "This resource provides configuration needed by Reana-UI.",
Expand Down Expand Up @@ -148,12 +144,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.",
Expand Down Expand Up @@ -1242,6 +1313,72 @@
"summary": "Requests a new access token for the authenticated user."
}
},
"/api/validation": {
"post": {
"consumes": [
"application/json"
],
"description": "Validate reana yaml in the server.",
"operationId": "validate_workflow",
"parameters": [
{
"description": "The yaml file to create the workflow.",
"in": "body",
"name": "reana_yaml",
"required": false,
"schema": {
"type": "object"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Get reana yaml validation results.",
"examples": {
"application/json": {
"message": "OK",
"status": 200
}
},
"schema": {
"properties": {
"message": {
"type": "object"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
"400": {
"description": "Error validating reana yaml",
"examples": {
"application/json": {
"message": "Invalid REANA specification: None is not of type 'object'.",
"status": 400
}
},
"schema": {
"properties": {
"message": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
}
},
"summary": "Validate reana yaml in the server"
}
},
"/api/workflows": {
"get": {
"description": "This resource return all current workflows in JSON format.",
Expand Down Expand Up @@ -4468,6 +4605,7 @@
"/oauth/disconnect/{remote_app}/": {},
"/oauth/login": {},
"/oauth/login/{remote_app}/": {},
"/oauth/logout": {},
"/oauth/signup/{remote_app}/": {},
"/oauth/static/{filename}": {},
"/signin": {},
Expand Down
Loading