Skip to content

Commit

Permalink
fixup! provisioning_api: Add OpenAPI spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@provokateurin
provokateurin committed Apr 16, 2023
1 parent 427c26e commit 0cb2e7f
Showing 1 changed file with 65 additions and 63 deletions.
128 changes: 65 additions & 63 deletions apps/provisioning_api/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@
"parameters": [
{
"name": "app",
"in": "query",
"in": "path",
"description": "ID of the app",
"required": true,
"schema": {
Expand Down Expand Up @@ -236,7 +236,7 @@
"parameters": [
{
"name": "app",
"in": "query",
"in": "path",
"description": "ID of the app",
"required": true,
"schema": {
Expand Down Expand Up @@ -999,29 +999,30 @@
"operationId": "groups-update-group",
"parameters": [
{
"name": "groupId",
"name": "key",
"in": "query",
"description": "ID of the group",
"description": "Key to update, only 'displayname'",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"name": "value",
"in": "query",
"description": "Key to update, only 'displayname'",
"description": "New value for the key",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"description": "New value for the key",
"name": "groupId",
"in": "path",
"description": "ID of the group",
"required": true,
"schema": {
"pattern": "^.+$",
"type": "string"
}
},
Expand Down Expand Up @@ -1086,10 +1087,11 @@
"parameters": [
{
"name": "groupId",
"in": "query",
"in": "path",
"description": "ID of the group",
"required": true,
"schema": {
"pattern": "^.+$",
"type": "string"
}
},
Expand Down Expand Up @@ -1725,27 +1727,27 @@
"operationId": "users-edit-user",
"parameters": [
{
"name": "userId",
"name": "key",
"in": "query",
"description": "ID of the user",
"description": "Key that will be updated",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"name": "value",
"in": "query",
"description": "Key that will be updated",
"description": "New value for the key",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"description": "New value for the key",
"name": "userId",
"in": "path",
"description": "ID of the user",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -1811,7 +1813,7 @@
"parameters": [
{
"name": "userId",
"in": "query",
"in": "path",
"description": "ID of the user",
"required": true,
"schema": {
Expand Down Expand Up @@ -2455,15 +2457,6 @@
"summary": "Add a user to a group",
"operationId": "users-add-to-group",
"parameters": [
{
"name": "userId",
"in": "query",
"description": "ID of the user",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupid",
"in": "query",
Expand All @@ -2473,6 +2466,15 @@
"default": ""
}
},
{
"name": "userId",
"in": "path",
"description": "ID of the user",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Expand Down Expand Up @@ -2532,18 +2534,18 @@
"operationId": "users-remove-from-group",
"parameters": [
{
"name": "userId",
"name": "groupid",
"in": "query",
"description": "ID of the user",
"description": "ID of the group",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupid",
"in": "query",
"description": "ID of the group",
"name": "userId",
"in": "path",
"description": "ID of the user",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -2682,18 +2684,18 @@
"operationId": "users-add-sub-admin",
"parameters": [
{
"name": "userId",
"name": "groupid",
"in": "query",
"description": "ID of the user",
"description": "ID of the group",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupid",
"in": "query",
"description": "ID of the group",
"name": "userId",
"in": "path",
"description": "ID of the user",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -2759,18 +2761,18 @@
"operationId": "users-remove-sub-admin",
"parameters": [
{
"name": "userId",
"name": "groupid",
"in": "query",
"description": "ID of the user",
"description": "ID of the group",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupid",
"in": "query",
"description": "ID of the group",
"name": "userId",
"in": "path",
"description": "ID of the user",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -3245,27 +3247,27 @@
"operationId": "app_config-set-value",
"parameters": [
{
"name": "app",
"name": "value",
"in": "query",
"description": "ID of the app",
"description": "New value for the key",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "Key to update",
"name": "app",
"in": "path",
"description": "ID of the app",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"description": "New value for the key",
"name": "key",
"in": "path",
"description": "Key to update",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -3378,7 +3380,7 @@
"parameters": [
{
"name": "app",
"in": "query",
"in": "path",
"description": "ID of the app",
"required": true,
"schema": {
Expand All @@ -3387,7 +3389,7 @@
},
{
"name": "key",
"in": "query",
"in": "path",
"description": "Key to delete",
"required": true,
"schema": {
Expand Down Expand Up @@ -3617,7 +3619,7 @@
"parameters": [
{
"name": "appId",
"in": "query",
"in": "path",
"description": "ID of the app",
"required": true,
"schema": {
Expand All @@ -3626,7 +3628,7 @@
},
{
"name": "configKey",
"in": "query",
"in": "path",
"description": "Key to delete",
"required": true,
"schema": {
Expand Down Expand Up @@ -3832,15 +3834,6 @@
"summary": "Delete multiple preferences for an app",
"operationId": "preferences-delete-multiple-preference",
"parameters": [
{
"name": "appId",
"in": "query",
"description": "ID of the app",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "configKeys",
"in": "query",
Expand All @@ -3853,6 +3846,15 @@
}
}
},
{
"name": "appId",
"in": "path",
"description": "ID of the app",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Expand Down

0 comments on commit 0cb2e7f

Please sign in to comment.