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

openapi: updated reana-server workspaces endpoint specification #291

Merged
merged 1 commit into from
Sep 15, 2021
Merged

openapi: updated reana-server workspaces endpoint specification #291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
85 changes: 39 additions & 46 deletions reana_commons/openapi_specifications/reana_server.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,52 +272,6 @@
"summary": "Ping the server (healthcheck)"
}
},
"/api/workspaces": {
"get":{
"consumes": [
"application/json"
],
"description": "Get the list of available workspaces.",
"operationId": "workspaces",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "This resource reports the available workspaces in the cluster.",
"examples": {
"application/json": {
"workspaces_available": ["/usr/share","/eos/home","/var/reana"],
"default": "/usr/share"
}
},
"schema": {
"properties": {
"workspaces_available": {
"type": "array",
"items": {
"type":"string"
}
},
"default": {
"type": "string"
}
},
"type": "object"
}
},
"500": {
"description": "Request failed. Internal server error.",
"examples": {
"application/json": {
"message": "Internal server error."
}
}
}
},
"summary": "Get the list of available workspaces."
}
},
"/api/secrets": {
"get": {
"description": "Get user secrets.",
Expand Down Expand Up @@ -2537,6 +2491,45 @@
"summary": "Returns the requested file."
}
},
"/api/workspaces": {
"get": {
"description": "This resource reports the available workspaces in the cluster.",
"operationId": "workspaces",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Request succeeded. The response contains the list of all workspaces.",
"examples": {
"application/json": {
"default": "/usr/share",
"workspaces_available": [
"/usr/share",
"/eos/home",
"/var/reana"
]
}
},
"schema": {
"properties": {
"workspaces_available": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"500": {
"description": "Request failed. Internal controller error."
}
},
"summary": "Get the list of available workspaces."
}
},
"/api/you": {
"get": {
"description": "This resource provides basic information about an authenticated user based on the session cookie presence.",
Expand Down