Fixes #25293: API documentation for user management in 8.2

Normation · Sep 2, 2024 · b9f2a60 · b9f2a60
1 parent ff7dc8d
commit b9f2a60
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 22 deletions.
diff --git a/webapp/sources/api-doc/components/schemas/user.yml b/webapp/sources/api-doc/components/schemas/user.yml
@@ -75,6 +75,9 @@ properties:
         type: array
         items:
           $ref: right.yml
+  tenants:
+    type: string
+    example: all
   lastLogin:
     type: string
     format: date-time
diff --git a/webapp/sources/api-doc/openapi.src.yml b/webapp/sources/api-doc/openapi.src.yml
@@ -57,6 +57,8 @@ tags:
     description: Server configuration
   - name: System
     description: Internal components and administration
+  - name: User management
+    description: Manage user information and configuration file
   - name: Plugins
     description: Information about installed plugins
   - name: "🧩 Change requests"
@@ -89,12 +91,6 @@ tags:
 
 
       Manage relays.
-  - name: "🧩 User Management"
-    description: >-
-      **Requires that the `user-management` plugin is installed on the server.**
-
-
-      Manage user information and configuration file.
   - name: "🧩 Branding"
     description: >-
       **Requires that the `branding` plugin is installed on the server.**

diff --git a/webapp/sources/api-doc/paths/usermanagement/add.yml b/webapp/sources/api-doc/paths/usermanagement/add.yml
@@ -71,7 +71,7 @@ post:
                         example:
                           phone: "+1234"
   tags:
-    - 🧩 User Management
+    - User management
   x-codeSamples:
     - lang: curl
       source:

diff --git a/webapp/sources/api-doc/paths/usermanagement/all.yml b/webapp/sources/api-doc/paths/usermanagement/all.yml
@@ -30,17 +30,13 @@ get:
               data:
                 type: object
                 required:
-                  - digest
+                  - roleListOverride
+                  - authenticationBackends
+                  - providerProperties
                   - users
+                  - digest
+                  - tenantsEnabled
                 properties:
-                  digest:
-                    type: string
-                    enum:
-                      - BCRYPT
-                      - SHA512
-                      - SHA256
-                      - SHA1
-                      - MD5
                   roleListOverride:
                     $ref: ../../components/schemas/role-list-override.yml
                   authenticationBackends:
@@ -68,8 +64,19 @@ get:
                     type: array
                     items:
                       $ref: ../../components/schemas/user.yml
+                  digest:
+                    type: string
+                    enum:
+                      - BCRYPT
+                    description: Default password hash algorithm
+                  tenantsEnabled:
+                    type: boolean
+                    description: Whether the tenants plugin is enabled or not, indicating if users only belong to their assigned tenants
+                    enum:
+                      - false
+                      - true
   tags:
-    - 🧩 User Management
+    - User management
   x-codeSamples:
     - lang: curl
       source:

diff --git a/webapp/sources/api-doc/paths/usermanagement/id.yml b/webapp/sources/api-doc/paths/usermanagement/id.yml
@@ -44,7 +44,7 @@ delete:
                         description: Username of the deleted user
                         example: Toto
   tags:
-    - 🧩 User Management
+    - User management
   x-codeSamples:
     - lang: curl
       source:

diff --git a/webapp/sources/api-doc/paths/usermanagement/reload.yml b/webapp/sources/api-doc/paths/usermanagement/reload.yml
@@ -42,7 +42,7 @@ get:
                         example: Done
 
   tags:
-    - 🧩 User Management
+    - User management
   x-codeSamples:
     - lang: curl
       source:

diff --git a/webapp/sources/api-doc/paths/usermanagement/roles.yml b/webapp/sources/api-doc/paths/usermanagement/roles.yml
@@ -53,7 +53,7 @@ get:
                           - userAccount_all
 
   tags:
-    - 🧩 User Management
+    - User management
   x-codeSamples:
     - lang: curl
       source:

diff --git a/webapp/sources/api-doc/paths/usermanagement/update-info.yml b/webapp/sources/api-doc/paths/usermanagement/update-info.yml
@@ -54,7 +54,7 @@ post:
                         example:
                           phone: "+1234"
   tags:
-    - 🧩 User Management
+    - User management
   x-codeSamples:
     - lang: curl
       source:

diff --git a/webapp/sources/api-doc/paths/usermanagement/update.yml b/webapp/sources/api-doc/paths/usermanagement/update.yml
@@ -60,7 +60,7 @@ post:
                           type: string
                           example: inventory
   tags:
-    - 🧩 User Management
+    - User management
   x-codeSamples:
     - lang: curl
       source: