aboutsummaryrefslogtreecommitdiffstats
path: root/apps/provisioning_api/openapi-full.json
diff options
context:
space:
mode:
Diffstat (limited to 'apps/provisioning_api/openapi-full.json')
-rw-r--r--apps/provisioning_api/openapi-full.json887
1 files changed, 489 insertions, 398 deletions
diff --git a/apps/provisioning_api/openapi-full.json b/apps/provisioning_api/openapi-full.json
index a1a2d10e13c..e7c094c214d 100644
--- a/apps/provisioning_api/openapi-full.json
+++ b/apps/provisioning_api/openapi-full.json
@@ -404,16 +404,24 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "filter",
- "in": "query",
- "description": "Filter for enabled or disabled apps",
- "schema": {
- "type": "string",
- "nullable": true
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "type": "string",
+ "nullable": true,
+ "description": "Filter for enabled or disabled apps"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -769,36 +777,36 @@
"basic_auth": []
}
],
- "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
+ "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": "OCS-APIRequest",
"in": "header",
@@ -1026,16 +1034,26 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "groupid",
- "in": "query",
- "description": "ID of the group",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "groupid"
+ ],
+ "properties": {
+ "groupid": {
+ "type": "string",
+ "description": "ID of the group"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "userId",
"in": "path",
@@ -1102,16 +1120,26 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "groupid",
- "in": "query",
- "description": "ID of the group",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "groupid"
+ ],
+ "properties": {
+ "groupid": {
+ "type": "string",
+ "description": "ID of the group"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "userId",
"in": "path",
@@ -1381,16 +1409,26 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "value",
- "in": "query",
- "description": "New value for the key",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "New value for the key"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "app",
"in": "path",
@@ -1513,36 +1551,36 @@
"basic_auth": []
}
],
- "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
+ "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": "OCS-APIRequest",
"in": "header",
@@ -1752,36 +1790,36 @@
"basic_auth": []
}
],
- "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
+ "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",
"in": "path",
@@ -1878,36 +1916,36 @@
"basic_auth": []
}
],
- "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
+ "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": "OCS-APIRequest",
"in": "header",
@@ -1978,94 +2016,72 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "userid",
- "in": "query",
- "description": "ID of the user",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "Password of the user",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "displayName",
- "in": "query",
- "description": "Display name of the user",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "email",
- "in": "query",
- "description": "Email of the user",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "groups[]",
- "in": "query",
- "description": "Groups of the user",
- "schema": {
- "type": "array",
- "default": [],
- "items": {
- "type": "string"
- }
- }
- },
- {
- "name": "subadmin[]",
- "in": "query",
- "description": "Groups where the user is subadmin",
- "schema": {
- "type": "array",
- "default": [],
- "items": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "userid"
+ ],
+ "properties": {
+ "userid": {
+ "type": "string",
+ "description": "ID of the user"
+ },
+ "password": {
+ "type": "string",
+ "default": "",
+ "description": "Password of the user"
+ },
+ "displayName": {
+ "type": "string",
+ "default": "",
+ "description": "Display name of the user"
+ },
+ "email": {
+ "type": "string",
+ "default": "",
+ "description": "Email of the user"
+ },
+ "groups": {
+ "type": "array",
+ "default": [],
+ "description": "Groups of the user",
+ "items": {
+ "type": "string"
+ }
+ },
+ "subadmin": {
+ "type": "array",
+ "default": [],
+ "description": "Groups where the user is subadmin",
+ "items": {
+ "type": "string"
+ }
+ },
+ "quota": {
+ "type": "string",
+ "default": "",
+ "description": "Quota of the user"
+ },
+ "language": {
+ "type": "string",
+ "default": "",
+ "description": "Language of the user"
+ },
+ "manager": {
+ "type": "string",
+ "nullable": true,
+ "description": "Manager of the user"
+ }
+ }
}
}
- },
- {
- "name": "quota",
- "in": "query",
- "description": "Quota of the user",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "language",
- "in": "query",
- "description": "Language of the user",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "manager",
- "in": "query",
- "description": "Manager of the user",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -2162,36 +2178,36 @@
"basic_auth": []
}
],
- "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
+ "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": "OCS-APIRequest",
"in": "header",
@@ -2278,36 +2294,36 @@
"basic_auth": []
}
],
- "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
+ "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": "OCS-APIRequest",
"in": "header",
@@ -2394,25 +2410,37 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "location",
- "in": "query",
- "description": "Location of the phone number (for country code)",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "search",
- "in": "query",
- "description": "Phone numbers to search for",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "location",
+ "search"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Location of the phone number (for country code)"
+ },
+ "search": {
+ "type": "object",
+ "description": "Phone numbers to search for",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -2573,25 +2601,31 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "key",
- "in": "query",
- "description": "Key that will be updated",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "value",
- "in": "query",
- "description": "New value for the key",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "key",
+ "value"
+ ],
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key that will be updated"
+ },
+ "value": {
+ "type": "string",
+ "description": "New value for the key"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "userId",
"in": "path",
@@ -2925,25 +2959,31 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "key",
- "in": "query",
- "description": "Key that will be updated",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "value",
- "in": "query",
- "description": "New value for the key",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "key",
+ "value"
+ ],
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key that will be updated"
+ },
+ "value": {
+ "type": "string",
+ "description": "New value for the key"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "userId",
"in": "path",
@@ -3308,16 +3348,24 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "groupid",
- "in": "query",
- "description": "ID of the group",
- "schema": {
- "type": "string",
- "default": ""
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "groupid": {
+ "type": "string",
+ "default": "",
+ "description": "ID of the group"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "userId",
"in": "path",
@@ -3384,16 +3432,26 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "groupid",
- "in": "query",
- "description": "ID of the group",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "groupid"
+ ],
+ "properties": {
+ "groupid": {
+ "type": "string",
+ "description": "ID of the group"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "userId",
"in": "path",
@@ -3530,16 +3588,26 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "configValue",
- "in": "query",
- "description": "New value",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "configValue"
+ ],
+ "properties": {
+ "configValue": {
+ "type": "string",
+ "description": "New value"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "appId",
"in": "path",
@@ -3747,16 +3815,29 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "configs",
- "in": "query",
- "description": "Key-value pairs of the preferences",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "configs"
+ ],
+ "properties": {
+ "configs": {
+ "type": "object",
+ "description": "Key-value pairs of the preferences",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "appId",
"in": "path",
@@ -3850,19 +3931,29 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "configKeys[]",
- "in": "query",
- "description": "Keys to delete",
- "required": true,
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
+ "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",
"in": "path",
@@ -3945,4 +4036,4 @@
}
},
"tags": []
-} \ No newline at end of file
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-30 21:53:48 +0000