Skip to content

A platform for community discussion. Free, open, simple.

DEV: Document user merging in the official API (#44214)

Alan Guo Xiang Tand6516e0b6e9c
diff --git a/spec/requests/api/schemas/json/user_merge_request.json b/spec/requests/api/schemas/json/user_merge_request.json
new file mode 100644
index 00000000000..d81ef776532
--- /dev/null
+++ b/spec/requests/api/schemas/json/user_merge_request.json
@@ -0,0 +1,12 @@
+{
+ "additionalProperties": false,
+ "properties": {
+ "target_username": {
+ "type": "string",
+ "description": "Username of the user to merge into"
+ }
+ },
+ "required": [
+ "target_username"
+ ]
+}
diff --git a/spec/requests/api/users_spec.rb b/spec/requests/api/users_spec.rb
index 8cfac11f4e9..e7aefd2f36b 100644
--- a/spec/requests/api/users_spec.rb
+++ b/spec/requests/api/users_spec.rb
@@ -503,6 +503,43 @@ RSpec.describe "users" do
end
end
+ path "/admin/users/{id}/merge.json" do
+ post "Merge a user" do
+ tags "Users", "Admin"
+ operationId "mergeUser"
+ description "Merge a user into another user. Requires admin permissions. The source user cannot be a staff member. The merge runs in the background and deletes the source user when complete."
+ consumes "application/json"
+ parameter name: "Api-Key", in: :header, type: :string, required: true
+ parameter name: "Api-Username", in: :header, type: :string, required: true
+ parameter name: :id,
+ in: :path,
+ type: :integer,
+ required: true,
+ description: "ID of the user to merge"
+ expected_request_schema = load_spec_schema("user_merge_request")
+ parameter name: :params, in: :body, schema: expected_request_schema
+
+ produces "application/json"
+ response "200", "response" do
+ expected_response_schema = load_spec_schema("success_ok_response")
+ schema expected_response_schema
+
+ fab!(:source_user, :user)
+ fab!(:target_user, :user)
+ let(:id) { source_user.id }
+ let(:params) { { "target_username" => target_user.username } }
+ let(:"Api-Username") { admin.username }
+
+ before { sign_out }
+
+ it_behaves_like "a JSON endpoint", 200 do
+ let(:expected_response_schema) { expected_response_schema }
+ let(:expected_request_schema) { expected_request_schema }
+ end
+ end
+ end
+ end
+
path "/admin/users/{id}/log_out.json" do
post "Log a user out" do
tags "Users", "Admin"