From 0cb2e7f90319759a788f1ac19ee41718e82cb407 Mon Sep 17 00:00:00 2001 From: jld3103 Date: Sun, 16 Apr 2023 10:43:31 +0200 Subject: [PATCH] fixup! provisioning_api: Add OpenAPI spec --- apps/provisioning_api/openapi.json | 128 +++++++++++++++-------------- 1 file changed, 65 insertions(+), 63 deletions(-) diff --git a/apps/provisioning_api/openapi.json b/apps/provisioning_api/openapi.json index 1f4570f5daeb2..bc251c056acec 100644 --- a/apps/provisioning_api/openapi.json +++ b/apps/provisioning_api/openapi.json @@ -168,7 +168,7 @@ "parameters": [ { "name": "app", - "in": "query", + "in": "path", "description": "ID of the app", "required": true, "schema": { @@ -236,7 +236,7 @@ "parameters": [ { "name": "app", - "in": "query", + "in": "path", "description": "ID of the app", "required": true, "schema": { @@ -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" } }, @@ -1086,10 +1087,11 @@ "parameters": [ { "name": "groupId", - "in": "query", + "in": "path", "description": "ID of the group", "required": true, "schema": { + "pattern": "^.+$", "type": "string" } }, @@ -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" @@ -1811,7 +1813,7 @@ "parameters": [ { "name": "userId", - "in": "query", + "in": "path", "description": "ID of the user", "required": true, "schema": { @@ -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", @@ -2473,6 +2466,15 @@ "default": "" } }, + { + "name": "userId", + "in": "path", + "description": "ID of the user", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "OCS-APIRequest", "in": "header", @@ -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" @@ -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" @@ -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" @@ -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" @@ -3378,7 +3380,7 @@ "parameters": [ { "name": "app", - "in": "query", + "in": "path", "description": "ID of the app", "required": true, "schema": { @@ -3387,7 +3389,7 @@ }, { "name": "key", - "in": "query", + "in": "path", "description": "Key to delete", "required": true, "schema": { @@ -3617,7 +3619,7 @@ "parameters": [ { "name": "appId", - "in": "query", + "in": "path", "description": "ID of the app", "required": true, "schema": { @@ -3626,7 +3628,7 @@ }, { "name": "configKey", - "in": "query", + "in": "path", "description": "Key to delete", "required": true, "schema": { @@ -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", @@ -3853,6 +3846,15 @@ } } }, + { + "name": "appId", + "in": "path", + "description": "ID of the app", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "OCS-APIRequest", "in": "header",