Updated OpenAPI spec

kiesraad · Feb 10, 2025 · 5936788 · 5936788
1 parent 1e170a2
commit 5936788
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 0 deletions.
diff --git a/backend/openapi.json b/backend/openapi.json
@@ -1279,6 +1279,69 @@
           }
         }
       }
+    },
+    "/api/user/{user_id}": {
+      "put": {
+        "tags": [
+          "authentication"
+        ],
+        "summary": "Update a user",
+        "operationId": "user_update",
+        "parameters": [
+          {
+            "name": "user_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "minimum": 0
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateUserRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "User updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "User not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -2429,6 +2492,24 @@
           }
         }
       },
+      "UpdateUserRequest": {
+        "type": "object",
+        "required": [
+          "username",
+          "role"
+        ],
+        "properties": {
+          "fullname": {
+            "type": "string"
+          },
+          "role": {
+            "$ref": "#/components/schemas/Role"
+          },
+          "username": {
+            "type": "string"
+          }
+        }
+      },
       "User": {
         "type": "object",
         "description": "User object, corresponds to a row in the users table",

diff --git a/backend/src/authentication/api.rs b/backend/src/authentication/api.rs
@@ -319,6 +319,7 @@ pub struct UpdateUserRequest {
 #[utoipa::path(
     post,
     path = "/api/user",
+    request_body = CreateUserRequest,
     responses(
         (status = 201, description = "User created", body = User),
         (status = 500, description = "Internal server error", body = ErrorResponse),
@@ -343,6 +344,7 @@ pub async fn user_create(
 #[utoipa::path(
     put,
     path = "/api/user/{user_id}",
+    request_body = UpdateUserRequest,
     responses(
         (status = 200, description = "User updated", body = User),
         (status = 404, description = "User not found", body = ErrorResponse),

diff --git a/backend/src/lib.rs b/backend/src/lib.rs
@@ -161,6 +161,7 @@ pub fn create_openapi() -> utoipa::openapi::OpenApi {
             authentication::change_password,
             authentication::user_list,
             authentication::user_create,
+            authentication::user_update,
             election::election_list,
             election::election_create,
             election::election_details,
@@ -192,6 +193,8 @@ pub fn create_openapi() -> utoipa::openapi::OpenApi {
                 authentication::LoginResponse,
                 authentication::ChangePasswordRequest,
                 authentication::UserListResponse,
+                authentication::UpdateUserRequest,
+                authentication::CreateUserRequest,
                 data_entry::CandidateVotes,
                 data_entry::DataEntry,
                 data_entry::SaveDataEntryResponse,

diff --git a/frontend/lib/api/gen/openapi.ts b/frontend/lib/api/gen/openapi.ts
@@ -125,6 +125,13 @@ export type LOGOUT_REQUEST_PATH = `/api/user/logout`;
 export type WHOAMI_REQUEST_PARAMS = Record<string, never>;
 export type WHOAMI_REQUEST_PATH = `/api/user/whoami`;
 
+// /api/user/{user_id}
+export interface USER_UPDATE_REQUEST_PARAMS {
+  user_id: number;
+}
+export type USER_UPDATE_REQUEST_PATH = `/api/user/${number}`;
+export type USER_UPDATE_REQUEST_BODY = UpdateUserRequest;
+
 /** TYPES **/
 
 /**
@@ -537,6 +544,12 @@ export interface SummaryDifferencesCounts {
   unreturned_ballots_count: SumCount;
 }
 
+export interface UpdateUserRequest {
+  fullname?: string;
+  role: Role;
+  username: string;
+}
+
 /**
  * User object, corresponds to a row in the users table
  */