Files
api.pawol.nu/src/extensions/upload/documentation/1.0.0/upload.json
T

389 lines
9.1 KiB
JSON
Raw Normal View History

2022-05-12 06:23:19 +04:00
{
2022-05-12 19:06:59 +04:00
"/upload/files/count": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadFileResponse"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
}
},
2022-05-12 19:06:59 +04:00
"500": {
"description": "Internal Server Error",
2022-05-12 06:23:19 +04:00
"content": {
"application/json": {
"schema": {
2022-05-12 19:06:59 +04:00
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
}
}
2022-05-12 19:06:59 +04:00
},
"tags": [
"Upload - File"
],
"parameters": [],
"operationId": "get/upload/files/count"
}
},
"/upload/files": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadFileListResponse"
2022-05-12 06:23:19 +04:00
}
}
}
},
2022-05-12 19:06:59 +04:00
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
}
2022-05-12 19:06:59 +04:00
}
},
"tags": [
"Upload - File"
],
"parameters": [
{
"name": "sort",
"in": "query",
"description": "Sort by attributes ascending (asc) or descending (desc)",
"deprecated": false,
"required": false,
"schema": {
"type": "string"
}
2022-05-12 06:23:19 +04:00
},
2022-05-12 19:06:59 +04:00
{
"name": "pagination[withCount]",
"in": "query",
"description": "Retun page/pageSize (default: true)",
"deprecated": false,
"required": false,
"schema": {
"type": "boolean"
2022-05-12 06:23:19 +04:00
}
2022-05-12 19:06:59 +04:00
},
{
"name": "pagination[page]",
"in": "query",
"description": "Page number (default: 0)",
"deprecated": false,
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "pagination[pageSize]",
"in": "query",
"description": "Page size (default: 25)",
"deprecated": false,
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "pagination[start]",
"in": "query",
"description": "Offset value (default: 0)",
"deprecated": false,
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "pagination[limit]",
"in": "query",
"description": "Number of entities to return (default: 25)",
"deprecated": false,
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fields",
"in": "query",
"description": "Fields to return (ex: title,author)",
"deprecated": false,
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "populate",
"in": "query",
"description": "Relations to return",
"deprecated": false,
"required": false,
"schema": {
"type": "string"
}
}
],
"operationId": "get/upload/files"
}
},
"/upload/files/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadFileResponse"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
}
},
2022-05-12 19:06:59 +04:00
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
2022-05-12 06:23:19 +04:00
},
2022-05-12 19:06:59 +04:00
"tags": [
"Upload - File"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
],
"operationId": "get/upload/files/{id}"
},
"delete": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "integer",
"format": "int64"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
2022-05-12 06:23:19 +04:00
}
}
}
},
2022-05-12 19:06:59 +04:00
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
2022-05-12 06:23:19 +04:00
}
}
2022-05-12 19:06:59 +04:00
}
},
"tags": [
"Upload - File"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
],
"operationId": "delete/upload/files/{id}"
2022-05-12 06:23:19 +04:00
}
}
}