"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "sinceIds": {
- "type": "object",
- "default": [],
- "description": "Array indexed by widget Ids, contains date/id from which we want the new items",
- "additionalProperties": {
- "type": "string"
- }
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 7,
- "description": "Limit number of result items per widget",
- "minimum": 1,
- "maximum": 30
- },
- "widgets": {
- "type": "array",
- "default": [],
- "description": "Limit results to specific widgets",
- "items": {
- "type": "string"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "sinceIds",
+ "in": "query",
+ "description": "Array indexed by widget Ids, contains date/id from which we want the new items",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit number of result items per widget",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 7,
+ "minimum": 1,
+ "maximum": 30
+ }
+ },
+ {
+ "name": "widgets[]",
+ "in": "query",
+ "description": "Limit results to specific widgets",
+ "schema": {
+ "type": "array",
+ "default": [],
+ "items": {
+ "type": "string"
}
}
- }
- },
- "parameters": [
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "sinceIds": {
- "type": "object",
- "default": [],
- "description": "Array indexed by widget Ids, contains date/id from which we want the new items",
- "additionalProperties": {
- "type": "string"
- }
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 7,
- "description": "Limit number of result items per widget, not more than 30 are allowed",
- "minimum": 1,
- "maximum": 30
- },
- "widgets": {
- "type": "array",
- "default": [],
- "description": "Limit results to specific widgets",
- "items": {
- "type": "string"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "sinceIds",
+ "in": "query",
+ "description": "Array indexed by widget Ids, contains date/id from which we want the new items",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit number of result items per widget, not more than 30 are allowed",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 7,
+ "minimum": 1,
+ "maximum": 30
+ }
+ },
+ {
+ "name": "widgets[]",
+ "in": "query",
+ "description": "Limit results to specific widgets",
+ "schema": {
+ "type": "array",
+ "default": [],
+ "items": {
+ "type": "string"
}
}
- }
- },
- "parameters": [
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "location": {
- "type": "string",
- "nullable": true,
- "description": "location/URL to filter by"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "location",
+ "in": "query",
+ "description": "location/URL to filter by",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "url",
- "token"
- ],
- "properties": {
- "url": {
- "type": "string",
- "description": "URL of the server"
- },
- "token": {
- "type": "string",
- "description": "Token of the server"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "url",
+ "in": "query",
+ "description": "URL of the server",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "token",
+ "in": "query",
+ "description": "Token of the server",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "url",
- "token"
- ],
- "properties": {
- "url": {
- "type": "string",
- "description": "URL of the server"
- },
- "token": {
- "type": "string",
- "description": "Token of the server"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "url",
+ "in": "query",
+ "description": "URL of the server",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "token",
+ "in": "query",
+ "description": "Token of the server",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
}
}
},
+ "TemplateField": {
+ "type": "object",
+ "required": [
+ "index",
+ "content",
+ "type"
+ ],
+ "properties": {
+ "index": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
"TemplateFile": {
"type": "object",
"required": [
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string",
- "default": "/",
- "description": "The path relative to the user folder"
- },
- "depth": {
- "type": "integer",
- "format": "int64",
- "default": 1,
- "description": "The depth of the tree"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "path",
+ "in": "query",
+ "description": "The path relative to the user folder",
+ "schema": {
+ "type": "string",
+ "default": "/"
+ }
+ },
+ {
+ "name": "depth",
+ "in": "query",
+ "description": "The depth of the tree",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 1
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "default": "",
- "description": "File in the share"
- },
- "x": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Width of the preview"
- },
- "y": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Height of the preview"
- },
- "a": {
- "type": "boolean",
- "default": false,
- "description": "Whether to not crop the preview"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "token",
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "file",
+ "in": "query",
+ "description": "File in the share",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "x",
+ "in": "query",
+ "description": "Width of the preview",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "y",
+ "in": "query",
+ "description": "Height of the preview",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "a",
+ "in": "query",
+ "description": "Whether to not crop the preview",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "shared_with_me": {
- "type": "string",
- "default": "false",
- "description": "Only get shares with the current user"
- },
- "reshares": {
- "type": "string",
- "default": "false",
- "description": "Only get shares by the current user and reshares"
- },
- "subfiles": {
- "type": "string",
- "default": "false",
- "description": "Only get all shares in a folder"
- },
- "path": {
- "type": "string",
- "default": "",
- "description": "Get shares for a specific path"
- },
- "include_tags": {
- "type": "string",
- "default": "false",
- "description": "Include tags in the share"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "shared_with_me",
+ "in": "query",
+ "description": "Only get shares with the current user",
+ "schema": {
+ "type": "string",
+ "default": "false"
+ }
+ },
+ {
+ "name": "reshares",
+ "in": "query",
+ "description": "Only get shares by the current user and reshares",
+ "schema": {
+ "type": "string",
+ "default": "false"
+ }
+ },
+ {
+ "name": "subfiles",
+ "in": "query",
+ "description": "Only get all shares in a folder",
+ "schema": {
+ "type": "string",
+ "default": "false"
+ }
+ },
+ {
+ "name": "path",
+ "in": "query",
+ "description": "Get shares for a specific path",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "include_tags",
+ "in": "query",
+ "description": "Include tags in the share",
+ "schema": {
+ "type": "string",
+ "default": "false"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "path"
- ],
- "properties": {
- "path": {
- "type": "string",
- "description": "Path all shares will be relative to"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "path",
+ "in": "query",
+ "description": "Path all shares will be relative to",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "include_tags": {
- "type": "boolean",
- "default": false,
- "description": "Include tags in the share"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "id",
"type": "string"
}
},
+ {
+ "name": "include_tags",
+ "in": "query",
+ "description": "Include tags in the share",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "itemType": {
- "type": "string",
- "nullable": true,
- "description": "Limit to specific item types"
- },
- "page": {
- "type": "integer",
- "format": "int64",
- "default": 1,
- "description": "Page offset for searching"
- },
- "perPage": {
+ "parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "itemType",
+ "in": "query",
+ "description": "Limit to specific item types",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "description": "Page offset for searching",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 1
+ }
+ },
+ {
+ "name": "perPage",
+ "in": "query",
+ "description": "Limit amount of search results per page",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 200
+ }
+ },
+ {
+ "name": "shareType",
+ "in": "query",
+ "description": "Limit to specific share types",
+ "schema": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "type": "array",
+ "items": {
"type": "integer",
- "format": "int64",
- "default": 200,
- "description": "Limit amount of search results per page"
- },
- "shareType": {
- "nullable": true,
- "description": "Limit to specific share types",
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- }
- }
- ]
- },
- "lookup": {
- "type": "boolean",
- "default": false,
- "description": "If a global lookup should be performed too"
+ "format": "int64"
}
}
- }
+ ]
}
- }
- },
- "parameters": [
+ },
+ {
+ "name": "lookup",
+ "in": "query",
+ "description": "If a global lookup should be performed too",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "itemType"
- ],
- "properties": {
- "itemType": {
- "type": "string",
- "description": "Limit to specific item types"
- },
- "shareType": {
- "nullable": true,
- "description": "Limit to specific share types",
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- }
- }
- ]
+ "parameters": [
+ {
+ "name": "itemType",
+ "in": "query",
+ "description": "Limit to specific item types",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "shareType",
+ "in": "query",
+ "description": "Limit to specific share types",
+ "schema": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
}
}
- }
+ ]
}
- }
- },
- "parameters": [
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "fileId": {
- "type": "integer",
- "format": "int64",
- "default": -1,
- "description": "ID of the file"
- },
- "x": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Width of the preview"
- },
- "y": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Height of the preview"
- },
- "a": {
- "type": "boolean",
- "default": false,
- "description": "Whether to not crop the preview"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "query",
+ "description": "ID of the file",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": -1
+ }
+ },
+ {
+ "name": "x",
+ "in": "query",
+ "description": "Width of the preview",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "y",
+ "in": "query",
+ "description": "Height of the preview",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "a",
+ "in": "query",
+ "description": "Whether to not crop the preview",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
}
}
- },
+ ],
"responses": {
"200": {
"description": "Preview returned",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "default": "",
- "description": "Path of the file"
- },
- "x": {
- "type": "integer",
- "format": "int64",
- "default": 44,
- "description": "Width of the preview"
- },
- "y": {
- "type": "integer",
- "format": "int64",
- "default": 44,
- "description": "Height of the preview"
- },
- "version": {
- "type": "string",
- "default": "",
- "description": "Version of the file to get the preview for"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "file",
+ "in": "query",
+ "description": "Path of the file",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "x",
+ "in": "query",
+ "description": "Width of the preview",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 44
+ }
+ },
+ {
+ "name": "y",
+ "in": "query",
+ "description": "Height of the preview",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 44
+ }
+ },
+ {
+ "name": "version",
+ "in": "query",
+ "description": "Version of the file to get the preview for",
+ "schema": {
+ "type": "string",
+ "default": ""
}
}
- },
+ ],
"responses": {
"200": {
"description": "Preview returned",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "client_id",
- "state",
- "response_type"
- ],
- "properties": {
- "client_id": {
- "type": "string",
- "description": "Client ID"
- },
- "state": {
- "type": "string",
- "description": "State of the flow"
- },
- "response_type": {
- "type": "string",
- "description": "Response type for the flow"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "query",
+ "description": "Client ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "state",
+ "in": "query",
+ "description": "State of the flow",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "response_type",
+ "in": "query",
+ "description": "Response type for the flow",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
- },
+ ],
"responses": {
"200": {
"description": "Client not found",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "filter": {
- "type": "string",
- "nullable": true,
- "description": "Filter for enabled or disabled apps"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "description": "Filter for enabled or disabled apps",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of users returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of users returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "groupid"
- ],
- "properties": {
- "groupid": {
- "type": "string",
- "description": "ID of the group"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
"type": "string"
}
},
+ {
+ "name": "groupid",
+ "in": "query",
+ "description": "ID of the group",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "defaultValue": {
- "type": "string",
- "default": "",
- "description": "Default returned value if the value is empty"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "app",
"type": "string"
}
},
+ {
+ "name": "defaultValue",
+ "in": "query",
+ "description": "Default returned value if the value is empty",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "filter": {
- "type": "string",
- "nullable": true,
- "description": "Filter for enabled or disabled apps"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "description": "Filter for enabled or disabled apps",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of users returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of users returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "groupid"
- ],
- "properties": {
- "groupid": {
- "type": "string",
- "description": "ID of the group"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
"type": "string"
}
},
+ {
+ "name": "groupid",
+ "in": "query",
+ "description": "ID of the group",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "groupId",
"pattern": "^.+$"
}
},
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of users returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of users returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "groupid"
- ],
- "properties": {
- "groupid": {
- "type": "string",
- "description": "ID of the group"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
"type": "string"
}
},
+ {
+ "name": "groupid",
+ "in": "query",
+ "description": "ID of the group",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "configKeys"
- ],
- "properties": {
- "configKeys": {
- "type": "array",
- "description": "Keys to delete",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "configKeys[]",
+ "in": "query",
+ "description": "Keys to delete",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "groupId",
"pattern": "^.+$"
}
},
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of groups returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset for searching for groups"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of groups returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for searching for groups",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "search": {
- "type": "string",
- "default": "",
- "description": "Text to search for"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Limit the amount of users returned"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "default": 0,
- "description": "Offset"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Limit the amount of users returned",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "groupid"
- ],
- "properties": {
- "groupid": {
- "type": "string",
- "description": "ID of the group"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
"type": "string"
}
},
+ {
+ "name": "groupid",
+ "in": "query",
+ "description": "ID of the group",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "configKeys"
- ],
- "properties": {
- "configKeys": {
- "type": "array",
- "description": "Keys to delete",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "configKeys[]",
+ "in": "query",
+ "description": "Keys to delete",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "plain": {
- "type": "boolean",
- "default": false,
- "description": "Let the browser decide the CSS priority"
- },
- "withCustomCss": {
- "type": "boolean",
- "default": false,
- "description": "Include custom CSS"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "themeId",
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "plain",
+ "in": "query",
+ "description": "Let the browser decide the CSS priority",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "withCustomCss",
+ "in": "query",
+ "description": "Include custom CSS",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "useSvg": {
- "type": "boolean",
- "default": true,
- "description": "Return image as SVG"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "key",
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "useSvg",
+ "in": "query",
+ "description": "Return image as SVG",
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "version": {
- "type": "string",
- "nullable": true,
- "description": "The version to search the changelog entry for (defaults to the latest installed)"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "apiVersion",
"type": "string"
}
},
+ {
+ "name": "version",
+ "in": "query",
+ "description": "The version to search the changelog entry for (defaults to the latest installed)",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "showPassword": {
- "type": "boolean",
- "default": false,
- "description": "Whether to show the password"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "configID",
"type": "string"
}
},
+ {
+ "name": "showPassword",
+ "in": "query",
+ "description": "Whether to show the password",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Maximum number of statuses to find"
- },
- "offset": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Offset for finding statuses"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of statuses to find",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "Offset for finding statuses",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "uri": {
- "type": "string",
- "nullable": true,
- "description": "The callback URI to filter by"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "uri",
+ "in": "query",
+ "description": "The callback URI to filter by",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "providerIds",
- "taskTypeIds"
- ],
- "properties": {
- "providerIds": {
- "type": "array",
- "description": "The ids of the providers",
- "items": {
- "type": "string"
- }
- },
- "taskTypeIds": {
- "type": "array",
- "description": "The ids of the task types",
- "items": {
- "type": "string"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "providerIds[]",
+ "in": "query",
+ "description": "The ids of the providers",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
}
}
- }
- },
- "parameters": [
+ },
+ {
+ "name": "taskTypeIds[]",
+ "in": "query",
+ "description": "The ids of the task types",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "search"
- ],
- "properties": {
- "search": {
- "type": "string",
- "description": "Text to search for"
- },
- "itemType": {
- "type": "string",
- "nullable": true,
- "description": "Type of the items to search for"
- },
- "itemId": {
- "type": "string",
- "nullable": true,
- "description": "ID of the items to search for"
- },
- "sorter": {
- "type": "string",
- "nullable": true,
- "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\""
- },
- "shareTypes": {
- "type": "array",
- "default": [],
- "description": "Types of shares to search for",
- "items": {
- "type": "integer",
- "format": "int64"
- }
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 10,
- "description": "Maximum number of results to return"
- }
- }
+ "parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "itemType",
+ "in": "query",
+ "description": "Type of the items to search for",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "itemId",
+ "in": "query",
+ "description": "ID of the items to search for",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "sorter",
+ "in": "query",
+ "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "shareTypes[]",
+ "in": "query",
+ "description": "Types of shares to search for",
+ "schema": {
+ "type": "array",
+ "default": [],
+ "items": {
+ "type": "integer",
+ "format": "int64"
}
}
- }
- },
- "parameters": [
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of results to return",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 10
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "resourceType",
- "resourceId"
- ],
- "properties": {
- "resourceType": {
- "type": "string",
- "description": "Name of the resource"
- },
- "resourceId": {
- "type": "string",
- "description": "ID of the resource"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "collectionId",
"format": "int64"
}
},
+ {
+ "name": "resourceType",
+ "in": "query",
+ "description": "Name of the resource",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resourceId",
+ "in": "query",
+ "description": "ID of the resource",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "absolute": {
- "type": "boolean",
- "default": false,
- "description": "Rewrite URLs to absolute ones"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "absolute",
+ "in": "query",
+ "description": "Rewrite URLs to absolute ones",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "absolute": {
- "type": "boolean",
- "default": false,
- "description": "Rewrite URLs to absolute ones"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "absolute",
+ "in": "query",
+ "description": "Rewrite URLs to absolute ones",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "reference"
- ],
- "properties": {
- "reference": {
- "type": "string",
- "description": "Reference to resolve"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "reference",
+ "in": "query",
+ "description": "Reference to resolve",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "reference",
- "sharingToken"
- ],
- "properties": {
- "reference": {
- "type": "string",
- "description": "Reference to resolve"
- },
- "sharingToken": {
- "type": "string",
- "description": "Token of the public share"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "reference",
+ "in": "query",
+ "description": "Reference to resolve",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sharingToken",
+ "in": "query",
+ "description": "Token of the public share",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "customId": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "customId",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "taskType": {
- "type": "string",
- "nullable": true,
- "description": "The task type to filter by"
- },
- "customId": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
+ "name": "taskType",
+ "in": "query",
+ "description": "The task type to filter by",
"schema": {
- "type": "boolean",
- "default": true
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "customId",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "OCS-APIRequest",
+ "in": "header",
+ "description": "Required to be true for the API request to pass",
+ "required": true,
+ "schema": {
+ "type": "boolean",
+ "default": true
}
}
],
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "identifier",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "identifier",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "from": {
- "type": "string",
- "default": "",
- "description": "the url the user is currently at"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "from",
+ "in": "query",
+ "description": "the url the user is currently at",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "term": {
- "type": "string",
- "default": "",
- "description": "Term to search"
- },
- "sortOrder": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Order of entries"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Maximum amount of entries, limited to 25"
- },
- "cursor": {
- "nullable": true,
- "description": "Offset for searching",
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "string"
- }
- ]
- },
- "from": {
- "type": "string",
- "default": "",
- "description": "The current user URL"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "providerId",
"type": "string"
}
},
+ {
+ "name": "term",
+ "in": "query",
+ "description": "Term to search",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "sortOrder",
+ "in": "query",
+ "description": "Order of entries",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum amount of entries, limited to 25",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "cursor",
+ "in": "query",
+ "description": "Offset for searching",
+ "schema": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ {
+ "name": "from",
+ "in": "query",
+ "description": "The current user URL",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "guestFallback": {
- "type": "boolean",
- "default": false,
- "description": "Fallback to guest avatar if not found"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
512
]
}
+ },
+ {
+ "name": "guestFallback",
+ "in": "query",
+ "description": "Fallback to guest avatar if not found",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "guestFallback": {
- "type": "boolean",
- "default": false,
- "description": "Fallback to guest avatar if not found"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
512
]
}
+ },
+ {
+ "name": "guestFallback",
+ "in": "query",
+ "description": "Fallback to guest avatar if not found",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "darkTheme": {
- "type": "boolean",
- "nullable": true,
- "default": false,
- "description": "Return dark avatar"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "guestName",
512
]
}
+ },
+ {
+ "name": "darkTheme",
+ "in": "query",
+ "description": "Return dark avatar",
+ "schema": {
+ "type": "integer",
+ "nullable": true,
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "default": "",
- "description": "Path of the file"
- },
- "x": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Width of the preview. A width of -1 will use the original image width."
- },
- "y": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Height of the preview. A height of -1 will use the original image height."
- },
- "a": {
- "type": "boolean",
- "default": false,
- "description": "Preserve the aspect ratio"
- },
- "forceIcon": {
- "type": "boolean",
- "default": true,
- "description": "Force returning an icon"
- },
- "mode": {
- "type": "string",
- "default": "fill",
- "enum": [
- "fill",
- "cover"
- ],
- "description": "How to crop the image"
- },
- "mimeFallback": {
- "type": "boolean",
- "default": false,
- "description": "Whether to fallback to the mime icon if no preview is available"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "file",
+ "in": "query",
+ "description": "Path of the file",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "x",
+ "in": "query",
+ "description": "Width of the preview. A width of -1 will use the original image width.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "y",
+ "in": "query",
+ "description": "Height of the preview. A height of -1 will use the original image height.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "a",
+ "in": "query",
+ "description": "Preserve the aspect ratio",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "forceIcon",
+ "in": "query",
+ "description": "Force returning an icon",
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "mode",
+ "in": "query",
+ "description": "How to crop the image",
+ "schema": {
+ "type": "string",
+ "default": "fill",
+ "enum": [
+ "fill",
+ "cover"
+ ]
+ }
+ },
+ {
+ "name": "mimeFallback",
+ "in": "query",
+ "description": "Whether to fallback to the mime icon if no preview is available",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
}
}
- },
+ ],
"responses": {
"200": {
"description": "Preview returned",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "fileId": {
- "type": "integer",
- "format": "int64",
- "default": -1,
- "description": "ID of the file"
- },
- "x": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Width of the preview. A width of -1 will use the original image width."
- },
- "y": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Height of the preview. A height of -1 will use the original image height."
- },
- "a": {
- "type": "boolean",
- "default": false,
- "description": "Preserve the aspect ratio"
- },
- "forceIcon": {
- "type": "boolean",
- "default": true,
- "description": "Force returning an icon"
- },
- "mode": {
- "type": "string",
- "default": "fill",
- "enum": [
- "fill",
- "cover"
- ],
- "description": "How to crop the image"
- },
- "mimeFallback": {
- "type": "boolean",
- "default": false,
- "description": "Whether to fallback to the mime icon if no preview is available"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "query",
+ "description": "ID of the file",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": -1
+ }
+ },
+ {
+ "name": "x",
+ "in": "query",
+ "description": "Width of the preview. A width of -1 will use the original image width.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "y",
+ "in": "query",
+ "description": "Height of the preview. A height of -1 will use the original image height.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "a",
+ "in": "query",
+ "description": "Preserve the aspect ratio",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "forceIcon",
+ "in": "query",
+ "description": "Force returning an icon",
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "mode",
+ "in": "query",
+ "description": "How to crop the image",
+ "schema": {
+ "type": "string",
+ "default": "fill",
+ "enum": [
+ "fill",
+ "cover"
+ ]
+ }
+ },
+ {
+ "name": "mimeFallback",
+ "in": "query",
+ "description": "Whether to fallback to the mime icon if no preview is available",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
}
}
- },
+ ],
"responses": {
"200": {
"description": "Preview returned",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "providerIds",
- "taskTypeIds"
- ],
- "properties": {
- "providerIds": {
- "type": "array",
- "description": "The ids of the providers",
- "items": {
- "type": "string"
- }
- },
- "taskTypeIds": {
- "type": "array",
- "description": "The ids of the task types",
- "items": {
- "type": "string"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "providerIds[]",
+ "in": "query",
+ "description": "The ids of the providers",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
}
}
- }
- },
- "parameters": [
+ },
+ {
+ "name": "taskTypeIds[]",
+ "in": "query",
+ "description": "The ids of the task types",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "search"
- ],
- "properties": {
- "search": {
- "type": "string",
- "description": "Text to search for"
- },
- "itemType": {
- "type": "string",
- "nullable": true,
- "description": "Type of the items to search for"
- },
- "itemId": {
- "type": "string",
- "nullable": true,
- "description": "ID of the items to search for"
- },
- "sorter": {
- "type": "string",
- "nullable": true,
- "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\""
- },
- "shareTypes": {
- "type": "array",
- "default": [],
- "description": "Types of shares to search for",
- "items": {
- "type": "integer",
- "format": "int64"
- }
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 10,
- "description": "Maximum number of results to return"
- }
- }
+ "parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "description": "Text to search for",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "itemType",
+ "in": "query",
+ "description": "Type of the items to search for",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "itemId",
+ "in": "query",
+ "description": "ID of the items to search for",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "sorter",
+ "in": "query",
+ "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "shareTypes[]",
+ "in": "query",
+ "description": "Types of shares to search for",
+ "schema": {
+ "type": "array",
+ "default": [],
+ "items": {
+ "type": "integer",
+ "format": "int64"
}
}
- }
- },
- "parameters": [
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of results to return",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 10
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "resourceType",
- "resourceId"
- ],
- "properties": {
- "resourceType": {
- "type": "string",
- "description": "Name of the resource"
- },
- "resourceId": {
- "type": "string",
- "description": "ID of the resource"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "collectionId",
"format": "int64"
}
},
+ {
+ "name": "resourceType",
+ "in": "query",
+ "description": "Name of the resource",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resourceId",
+ "in": "query",
+ "description": "ID of the resource",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "absolute": {
- "type": "boolean",
- "default": false,
- "description": "Rewrite URLs to absolute ones"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "absolute",
+ "in": "query",
+ "description": "Rewrite URLs to absolute ones",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "absolute": {
- "type": "boolean",
- "default": false,
- "description": "Rewrite URLs to absolute ones"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "absolute",
+ "in": "query",
+ "description": "Rewrite URLs to absolute ones",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "reference"
- ],
- "properties": {
- "reference": {
- "type": "string",
- "description": "Reference to resolve"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "reference",
+ "in": "query",
+ "description": "Reference to resolve",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "reference",
- "sharingToken"
- ],
- "properties": {
- "reference": {
- "type": "string",
- "description": "Reference to resolve"
- },
- "sharingToken": {
- "type": "string",
- "description": "Token of the public share"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "reference",
+ "in": "query",
+ "description": "Reference to resolve",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sharingToken",
+ "in": "query",
+ "description": "Token of the public share",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "customId": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "customId",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "taskType": {
- "type": "string",
- "nullable": true,
- "description": "The task type to filter by"
- },
- "customId": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
+ "name": "taskType",
+ "in": "query",
+ "description": "The task type to filter by",
"schema": {
- "type": "boolean",
- "default": true
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "customId",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ {
+ "name": "OCS-APIRequest",
+ "in": "header",
+ "description": "Required to be true for the API request to pass",
+ "required": true,
+ "schema": {
+ "type": "boolean",
+ "default": true
}
}
],
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "identifier",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "nullable": true,
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "appId",
"type": "string"
}
},
+ {
+ "name": "identifier",
+ "in": "query",
+ "description": "An arbitrary identifier for the task",
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "from": {
- "type": "string",
- "default": "",
- "description": "the url the user is currently at"
- }
- }
- }
- }
- }
- },
"parameters": [
+ {
+ "name": "from",
+ "in": "query",
+ "description": "the url the user is currently at",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "term": {
- "type": "string",
- "default": "",
- "description": "Term to search"
- },
- "sortOrder": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Order of entries"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Maximum amount of entries, limited to 25"
- },
- "cursor": {
- "nullable": true,
- "description": "Offset for searching",
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "string"
- }
- ]
- },
- "from": {
- "type": "string",
- "default": "",
- "description": "The current user URL"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "providerId",
"type": "string"
}
},
+ {
+ "name": "term",
+ "in": "query",
+ "description": "Term to search",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "sortOrder",
+ "in": "query",
+ "description": "Order of entries",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum amount of entries, limited to 25",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ {
+ "name": "cursor",
+ "in": "query",
+ "description": "Offset for searching",
+ "schema": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ {
+ "name": "from",
+ "in": "query",
+ "description": "The current user URL",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
{
"name": "OCS-APIRequest",
"in": "header",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "guestFallback": {
- "type": "boolean",
- "default": false,
- "description": "Fallback to guest avatar if not found"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
512
]
}
+ },
+ {
+ "name": "guestFallback",
+ "in": "query",
+ "description": "Fallback to guest avatar if not found",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "guestFallback": {
- "type": "boolean",
- "default": false,
- "description": "Fallback to guest avatar if not found"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "userId",
512
]
}
+ },
+ {
+ "name": "guestFallback",
+ "in": "query",
+ "description": "Fallback to guest avatar if not found",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "darkTheme": {
- "type": "boolean",
- "nullable": true,
- "default": false,
- "description": "Return dark avatar"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "guestName",
512
]
}
+ },
+ {
+ "name": "darkTheme",
+ "in": "query",
+ "description": "Return dark avatar",
+ "schema": {
+ "type": "integer",
+ "nullable": true,
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "default": "",
- "description": "Path of the file"
- },
- "x": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Width of the preview. A width of -1 will use the original image width."
- },
- "y": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Height of the preview. A height of -1 will use the original image height."
- },
- "a": {
- "type": "boolean",
- "default": false,
- "description": "Preserve the aspect ratio"
- },
- "forceIcon": {
- "type": "boolean",
- "default": true,
- "description": "Force returning an icon"
- },
- "mode": {
- "type": "string",
- "default": "fill",
- "enum": [
- "fill",
- "cover"
- ],
- "description": "How to crop the image"
- },
- "mimeFallback": {
- "type": "boolean",
- "default": false,
- "description": "Whether to fallback to the mime icon if no preview is available"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "file",
+ "in": "query",
+ "description": "Path of the file",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "x",
+ "in": "query",
+ "description": "Width of the preview. A width of -1 will use the original image width.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "y",
+ "in": "query",
+ "description": "Height of the preview. A height of -1 will use the original image height.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "a",
+ "in": "query",
+ "description": "Preserve the aspect ratio",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "forceIcon",
+ "in": "query",
+ "description": "Force returning an icon",
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "mode",
+ "in": "query",
+ "description": "How to crop the image",
+ "schema": {
+ "type": "string",
+ "default": "fill",
+ "enum": [
+ "fill",
+ "cover"
+ ]
+ }
+ },
+ {
+ "name": "mimeFallback",
+ "in": "query",
+ "description": "Whether to fallback to the mime icon if no preview is available",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
}
}
- },
+ ],
"responses": {
"200": {
"description": "Preview returned",
"basic_auth": []
}
],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "fileId": {
- "type": "integer",
- "format": "int64",
- "default": -1,
- "description": "ID of the file"
- },
- "x": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Width of the preview. A width of -1 will use the original image width."
- },
- "y": {
- "type": "integer",
- "format": "int64",
- "default": 32,
- "description": "Height of the preview. A height of -1 will use the original image height."
- },
- "a": {
- "type": "boolean",
- "default": false,
- "description": "Preserve the aspect ratio"
- },
- "forceIcon": {
- "type": "boolean",
- "default": true,
- "description": "Force returning an icon"
- },
- "mode": {
- "type": "string",
- "default": "fill",
- "enum": [
- "fill",
- "cover"
- ],
- "description": "How to crop the image"
- },
- "mimeFallback": {
- "type": "boolean",
- "default": false,
- "description": "Whether to fallback to the mime icon if no preview is available"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "query",
+ "description": "ID of the file",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": -1
+ }
+ },
+ {
+ "name": "x",
+ "in": "query",
+ "description": "Width of the preview. A width of -1 will use the original image width.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "y",
+ "in": "query",
+ "description": "Height of the preview. A height of -1 will use the original image height.",
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32
+ }
+ },
+ {
+ "name": "a",
+ "in": "query",
+ "description": "Preserve the aspect ratio",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "forceIcon",
+ "in": "query",
+ "description": "Force returning an icon",
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
+ },
+ {
+ "name": "mode",
+ "in": "query",
+ "description": "How to crop the image",
+ "schema": {
+ "type": "string",
+ "default": "fill",
+ "enum": [
+ "fill",
+ "cover"
+ ]
+ }
+ },
+ {
+ "name": "mimeFallback",
+ "in": "query",
+ "description": "Whether to fallback to the mime icon if no preview is available",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
}
}
- },
+ ],
"responses": {
"200": {
"description": "Preview returned",
"php": "8.1"
}
},
- "repositories": [
- {
- "type": "vcs",
- "url": "https://github.com/nextcloud/openapi-extractor"
- }
- ],
"require": {
- "nextcloud/openapi-extractor": "dev-main"
+ "nextcloud/openapi-extractor": "^1.0.0"
}
}
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
- "content-hash": "143725e36726d6a8e8fc092c8b44a4ee",
+ "content-hash": "23c96ff7007b72dfd2bbe9cbf35a2843",
"packages": [
{
"name": "adhocore/cli",
},
{
"name": "nextcloud/openapi-extractor",
- "version": "dev-main",
+ "version": "v1.0.0",
"source": {
"type": "git",
- "url": "https://github.com/nextcloud/openapi-extractor.git",
- "reference": "82473016d48704ed21e75ea2afa9b0262b9b9a6d"
+ "url": "https://github.com/nextcloud-releases/openapi-extractor.git",
+ "reference": "88e347097db28b6e3f8f3c221502b80a4f455b1f"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/nextcloud/openapi-extractor/zipball/82473016d48704ed21e75ea2afa9b0262b9b9a6d",
- "reference": "82473016d48704ed21e75ea2afa9b0262b9b9a6d",
+ "url": "https://api.github.com/repos/nextcloud-releases/openapi-extractor/zipball/88e347097db28b6e3f8f3c221502b80a4f455b1f",
+ "reference": "88e347097db28b6e3f8f3c221502b80a4f455b1f",
"shasum": ""
},
"require": {
"nextcloud/coding-standard": "^1.2",
"nextcloud/ocp": "dev-master"
},
- "default-branch": true,
"bin": [
"generate-spec",
"merge-specs"
"OpenAPIExtractor\\": "src"
}
},
- "scripts": {
- "lint": [
- "find . -name \\*.php -not -path './tests/*' -not -path './vendor/*' -not -path './build/*' -print0 | xargs -0 -n1 php -l && php -l generate-spec && php -l merge-specs"
- ],
- "cs:check": [
- "php-cs-fixer fix --dry-run --diff"
- ],
- "cs:fix": [
- "php-cs-fixer fix"
- ],
- "test:unit": [
- "cd tests && ../generate-spec"
- ]
- },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "AGPL-3.0-or-later"
+ ],
+ "description": "A tool for extracting OpenAPI specifications from Nextcloud source code",
"support": {
- "source": "https://github.com/nextcloud/openapi-extractor/tree/main",
- "issues": "https://github.com/nextcloud/openapi-extractor/issues"
+ "issues": "https://github.com/nextcloud-releases/openapi-extractor/issues",
+ "source": "https://github.com/nextcloud-releases/openapi-extractor/tree/v1.0.0"
},
- "time": "2024-07-02T07:11:51+00:00"
+ "time": "2024-08-20T16:46:27+00:00"
},
{
"name": "nikic/php-parser",
"packages-dev": [],
"aliases": [],
"minimum-stability": "stable",
- "stability-flags": {
- "nextcloud/openapi-extractor": 20
- },
+ "stability-flags": [],
"prefer-stable": false,
"prefer-lowest": false,
"platform": [],
projects / nextcloud-server.git / commitdiff