diff --git a/swagger/parameters/index.yml b/swagger/parameters/index.yml index daedad351..3e8f0cb68 100644 --- a/swagger/parameters/index.yml +++ b/swagger/parameters/index.yml @@ -24,3 +24,6 @@ contact_sort_param: page: $ref: ./page.yml + +platform_user_id: + $ref: ./platform_user_id.yml diff --git a/swagger/parameters/platform_user_id.yml b/swagger/parameters/platform_user_id.yml new file mode 100644 index 000000000..708a0aad9 --- /dev/null +++ b/swagger/parameters/platform_user_id.yml @@ -0,0 +1,6 @@ +in: path +name: id +schema: + type: integer +required: true +description: The numeric ID of the user on the platform diff --git a/swagger/paths/index.yml b/swagger/paths/index.yml index 3c6b16185..f4ece98a3 100644 --- a/swagger/paths/index.yml +++ b/swagger/paths/index.yml @@ -52,7 +52,7 @@ platform/api/v1/users: $ref: ./platform/users/create.yml platform/api/v1/users/{id}: parameters: - - $ref: '#/parameters/user_id' + - $ref: '#/parameters/platform_user_id' get: $ref: './platform/users/show.yml' patch: @@ -61,7 +61,7 @@ platform/api/v1/users/{id}: $ref: ./platform/users/delete.yml platform/api/v1/users/{id}/login: parameters: - - $ref: '#/parameters/user_id' + - $ref: '#/parameters/platform_user_id' $ref: './platform/users/login.yml' @@ -215,4 +215,3 @@ platform/api/v1/users/{id}/login: $ref: ./teams/update.yml delete: $ref: ./teams/delete.yml - diff --git a/swagger/swagger.json b/swagger/swagger.json index a4e7a9377..b9db2b77e 100644 --- a/swagger/swagger.json +++ b/swagger/swagger.json @@ -550,7 +550,7 @@ "platform/api/v1/users/{id}": { "parameters": [ { - "$ref": "#/parameters/user_id" + "$ref": "#/parameters/platform_user_id" } ], "get": { @@ -3201,6 +3201,15 @@ }, "required": false, "description": "The page parameter" + }, + "platform_user_id": { + "in": "path", + "name": "id", + "schema": { + "type": "integer" + }, + "required": true, + "description": "The numeric ID of the user on the platform" } }, "x-tagGroups": [