Skip to content

Commit

Permalink
openapi: add pagination args
Browse files Browse the repository at this point in the history 
closes reanahub/reana-server#180
  • Loading branch information
@mvidalgarcia
mvidalgarcia committed Jul 20, 2020
1 parent 8910b38 commit fc8a0bd
Show file tree
Hide file tree
Showing 2 changed files with 186 additions and 70 deletions.
128 changes: 93 additions & 35 deletions reana_commons/openapi_specifications/reana_server.json
View file
Expand Up @@ -797,6 +797,20 @@
"name": "block_size",
"required": false,
"type": "string"
},
{
"description": "Results page number (pagination).",
"in": "query",
"name": "page",
"required": false,
"type": "string"
},
{
"description": "Number of results per page (pagination).",
"in": "query",
"name": "size",
"required": false,
"type": "string"
}
],
"produces": [
Expand Down Expand Up @@ -842,33 +856,41 @@
]
},
"schema": {
"items": {
"properties": {
"created": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"progress": {
"properties": {
"items": {
"items": {
"properties": {
"created": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"progress": {
"type": "object"
},
"size": {
"type": "string"
},
"status": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
},
"size": {
"type": "string"
},
"status": {
"type": "string"
},
"user": {
"type": "string"
}
"type": "array"
},
"type": "object"
"total": {
"type": "integer"
}
},
"type": "array"
"type": "object"
}
},
"400": {
Expand Down Expand Up @@ -1411,6 +1433,20 @@
},
"type": "array"
}
},
{
"description": "Results page number (pagination).",
"in": "query",
"name": "page",
"required": false,
"type": "string"
},
{
"description": "Number of results per page (pagination).",
"in": "query",
"name": "size",
"required": false,
"type": "string"
}
],
"produces": [
Expand Down Expand Up @@ -2106,6 +2142,20 @@
"name": "access_token",
"required": false,
"type": "string"
},
{
"description": "Results page number (pagination).",
"in": "query",
"name": "page",
"required": false,
"type": "string"
},
{
"description": "Number of results per page (pagination).",
"in": "query",
"name": "size",
"required": false,
"type": "string"
}
],
"produces": [
Expand All @@ -2115,21 +2165,29 @@
"200": {
"description": "Requests succeeded. The list of files has been retrieved.",
"schema": {
"items": {
"properties": {
"last-modified": {
"type": "string"
},
"name": {
"type": "string"
"properties": {
"items": {
"items": {
"properties": {
"last-modified": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"size": {
"type": "integer"
}
"type": "array"
},
"type": "object"
"total": {
"type": "integer"
}
},
"type": "array"
"type": "object"
}
},
"400": {
Expand Down
128 changes: 93 additions & 35 deletions reana_commons/openapi_specifications/reana_workflow_controller.json
View file
Expand Up @@ -39,6 +39,20 @@
"name": "block_size",
"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": [
Expand Down Expand Up @@ -84,33 +98,41 @@
]
},
"schema": {
"items": {
"properties": {
"created": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"progress": {
"properties": {
"items": {
"items": {
"properties": {
"created": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"progress": {
"type": "object"
},
"size": {
"type": "string"
},
"status": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
},
"size": {
"type": "string"
},
"status": {
"type": "string"
},
"user": {
"type": "string"
}
"type": "array"
},
"type": "object"
"total": {
"type": "integer"
}
},
"type": "array"
"type": "object"
}
},
"400": {
Expand Down Expand Up @@ -518,6 +540,20 @@
},
"type": "array"
}
},
{
"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": [
Expand Down Expand Up @@ -1006,6 +1042,20 @@
"name": "workflow_id_or_name",
"required": true,
"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": [
Expand All @@ -1015,21 +1065,29 @@
"200": {
"description": "Requests succeeded. The list of code|input|output files has been retrieved.",
"schema": {
"items": {
"properties": {
"last-modified": {
"type": "string"
},
"name": {
"type": "string"
"properties": {
"items": {
"items": {
"properties": {
"last-modified": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"size": {
"type": "integer"
}
"type": "array"
},
"type": "object"
"total": {
"type": "integer"
}
},
"type": "array"
"type": "object"
}
},
"400": {
Expand Down

0 comments on commit fc8a0bd

Please sign in to comment.