Skip to content

Commit 0cb2e7f

Browse files
provokateurinprovokateurin
committed
fixup! provisioning_api: Add OpenAPI spec
1 parent 427c26e commit 0cb2e7f

File tree

1 file changed

+65
-63
lines changed

1 file changed

+65
-63
lines changed

‎apps/provisioning_api/openapi.json

+65-63
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
"parameters": [
169169
{
170170
"name": "app",
171-
"in": "query",
171+
"in": "path",
172172
"description": "ID of the app",
173173
"required": true,
174174
"schema": {
@@ -236,7 +236,7 @@
236236
"parameters": [
237237
{
238238
"name": "app",
239-
"in": "query",
239+
"in": "path",
240240
"description": "ID of the app",
241241
"required": true,
242242
"schema": {
@@ -999,29 +999,30 @@
999999
"operationId": "groups-update-group",
10001000
"parameters": [
10011001
{
1002-
"name": "groupId",
1002+
"name": "key",
10031003
"in": "query",
1004-
"description": "ID of the group",
1004+
"description": "Key to update, only 'displayname'",
10051005
"required": true,
10061006
"schema": {
10071007
"type": "string"
10081008
}
10091009
},
10101010
{
1011-
"name": "key",
1011+
"name": "value",
10121012
"in": "query",
1013-
"description": "Key to update, only 'displayname'",
1013+
"description": "New value for the key",
10141014
"required": true,
10151015
"schema": {
10161016
"type": "string"
10171017
}
10181018
},
10191019
{
1020-
"name": "value",
1021-
"in": "query",
1022-
"description": "New value for the key",
1020+
"name": "groupId",
1021+
"in": "path",
1022+
"description": "ID of the group",
10231023
"required": true,
10241024
"schema": {
1025+
"pattern": "^.+$",
10251026
"type": "string"
10261027
}
10271028
},
@@ -1086,10 +1087,11 @@
10861087
"parameters": [
10871088
{
10881089
"name": "groupId",
1089-
"in": "query",
1090+
"in": "path",
10901091
"description": "ID of the group",
10911092
"required": true,
10921093
"schema": {
1094+
"pattern": "^.+$",
10931095
"type": "string"
10941096
}
10951097
},
@@ -1725,27 +1727,27 @@
17251727
"operationId": "users-edit-user",
17261728
"parameters": [
17271729
{
1728-
"name": "userId",
1730+
"name": "key",
17291731
"in": "query",
1730-
"description": "ID of the user",
1732+
"description": "Key that will be updated",
17311733
"required": true,
17321734
"schema": {
17331735
"type": "string"
17341736
}
17351737
},
17361738
{
1737-
"name": "key",
1739+
"name": "value",
17381740
"in": "query",
1739-
"description": "Key that will be updated",
1741+
"description": "New value for the key",
17401742
"required": true,
17411743
"schema": {
17421744
"type": "string"
17431745
}
17441746
},
17451747
{
1746-
"name": "value",
1747-
"in": "query",
1748-
"description": "New value for the key",
1748+
"name": "userId",
1749+
"in": "path",
1750+
"description": "ID of the user",
17491751
"required": true,
17501752
"schema": {
17511753
"type": "string"
@@ -1811,7 +1813,7 @@
18111813
"parameters": [
18121814
{
18131815
"name": "userId",
1814-
"in": "query",
1816+
"in": "path",
18151817
"description": "ID of the user",
18161818
"required": true,
18171819
"schema": {
@@ -2455,15 +2457,6 @@
24552457
"summary": "Add a user to a group",
24562458
"operationId": "users-add-to-group",
24572459
"parameters": [
2458-
{
2459-
"name": "userId",
2460-
"in": "query",
2461-
"description": "ID of the user",
2462-
"required": true,
2463-
"schema": {
2464-
"type": "string"
2465-
}
2466-
},
24672460
{
24682461
"name": "groupid",
24692462
"in": "query",
@@ -2473,6 +2466,15 @@
24732466
"default": ""
24742467
}
24752468
},
2469+
{
2470+
"name": "userId",
2471+
"in": "path",
2472+
"description": "ID of the user",
2473+
"required": true,
2474+
"schema": {
2475+
"type": "string"
2476+
}
2477+
},
24762478
{
24772479
"name": "OCS-APIRequest",
24782480
"in": "header",
@@ -2532,18 +2534,18 @@
25322534
"operationId": "users-remove-from-group",
25332535
"parameters": [
25342536
{
2535-
"name": "userId",
2537+
"name": "groupid",
25362538
"in": "query",
2537-
"description": "ID of the user",
2539+
"description": "ID of the group",
25382540
"required": true,
25392541
"schema": {
25402542
"type": "string"
25412543
}
25422544
},
25432545
{
2544-
"name": "groupid",
2545-
"in": "query",
2546-
"description": "ID of the group",
2546+
"name": "userId",
2547+
"in": "path",
2548+
"description": "ID of the user",
25472549
"required": true,
25482550
"schema": {
25492551
"type": "string"
@@ -2682,18 +2684,18 @@
26822684
"operationId": "users-add-sub-admin",
26832685
"parameters": [
26842686
{
2685-
"name": "userId",
2687+
"name": "groupid",
26862688
"in": "query",
2687-
"description": "ID of the user",
2689+
"description": "ID of the group",
26882690
"required": true,
26892691
"schema": {
26902692
"type": "string"
26912693
}
26922694
},
26932695
{
2694-
"name": "groupid",
2695-
"in": "query",
2696-
"description": "ID of the group",
2696+
"name": "userId",
2697+
"in": "path",
2698+
"description": "ID of the user",
26972699
"required": true,
26982700
"schema": {
26992701
"type": "string"
@@ -2759,18 +2761,18 @@
27592761
"operationId": "users-remove-sub-admin",
27602762
"parameters": [
27612763
{
2762-
"name": "userId",
2764+
"name": "groupid",
27632765
"in": "query",
2764-
"description": "ID of the user",
2766+
"description": "ID of the group",
27652767
"required": true,
27662768
"schema": {
27672769
"type": "string"
27682770
}
27692771
},
27702772
{
2771-
"name": "groupid",
2772-
"in": "query",
2773-
"description": "ID of the group",
2773+
"name": "userId",
2774+
"in": "path",
2775+
"description": "ID of the user",
27742776
"required": true,
27752777
"schema": {
27762778
"type": "string"
@@ -3245,27 +3247,27 @@
32453247
"operationId": "app_config-set-value",
32463248
"parameters": [
32473249
{
3248-
"name": "app",
3250+
"name": "value",
32493251
"in": "query",
3250-
"description": "ID of the app",
3252+
"description": "New value for the key",
32513253
"required": true,
32523254
"schema": {
32533255
"type": "string"
32543256
}
32553257
},
32563258
{
3257-
"name": "key",
3258-
"in": "query",
3259-
"description": "Key to update",
3259+
"name": "app",
3260+
"in": "path",
3261+
"description": "ID of the app",
32603262
"required": true,
32613263
"schema": {
32623264
"type": "string"
32633265
}
32643266
},
32653267
{
3266-
"name": "value",
3267-
"in": "query",
3268-
"description": "New value for the key",
3268+
"name": "key",
3269+
"in": "path",
3270+
"description": "Key to update",
32693271
"required": true,
32703272
"schema": {
32713273
"type": "string"
@@ -3378,7 +3380,7 @@
33783380
"parameters": [
33793381
{
33803382
"name": "app",
3381-
"in": "query",
3383+
"in": "path",
33823384
"description": "ID of the app",
33833385
"required": true,
33843386
"schema": {
@@ -3387,7 +3389,7 @@
33873389
},
33883390
{
33893391
"name": "key",
3390-
"in": "query",
3392+
"in": "path",
33913393
"description": "Key to delete",
33923394
"required": true,
33933395
"schema": {
@@ -3617,7 +3619,7 @@
36173619
"parameters": [
36183620
{
36193621
"name": "appId",
3620-
"in": "query",
3622+
"in": "path",
36213623
"description": "ID of the app",
36223624
"required": true,
36233625
"schema": {
@@ -3626,7 +3628,7 @@
36263628
},
36273629
{
36283630
"name": "configKey",
3629-
"in": "query",
3631+
"in": "path",
36303632
"description": "Key to delete",
36313633
"required": true,
36323634
"schema": {
@@ -3832,15 +3834,6 @@
38323834
"summary": "Delete multiple preferences for an app",
38333835
"operationId": "preferences-delete-multiple-preference",
38343836
"parameters": [
3835-
{
3836-
"name": "appId",
3837-
"in": "query",
3838-
"description": "ID of the app",
3839-
"required": true,
3840-
"schema": {
3841-
"type": "string"
3842-
}
3843-
},
38443837
{
38453838
"name": "configKeys",
38463839
"in": "query",
@@ -3853,6 +3846,15 @@
38533846
}
38543847
}
38553848
},
3849+
{
3850+
"name": "appId",
3851+
"in": "path",
3852+
"description": "ID of the app",
3853+
"required": true,
3854+
"schema": {
3855+
"type": "string"
3856+
}
3857+
},
38563858
{
38573859
"name": "OCS-APIRequest",
38583860
"in": "header",

0 commit comments

Comments
 (0)