docs: Update user field description

anarsultanov · Feb 26, 2024 · e0629ff · e0629ff
1 parent 9b00a33
commit e0629ff
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/docs/openapi.json b/docs/openapi.json
@@ -571,6 +571,7 @@
             "readOnly" : true
           },
           "user" : {
+            "description" : "Returns basic user info only including id, username, creation date, names, email, enabled state, email verification and federation link.",
             "type" : "object",
             "allOf" : [ {
               "$ref" : "#/components/schemas/UserRepresentation"

diff --git a/docs/openapi.yaml b/docs/openapi.yaml
@@ -397,6 +397,9 @@ components:
           type: string
           readOnly: true
         user:
+          description: "Returns basic user info only including id, username, creation\
+            \ date, names, email, enabled state, email verification and federation\
+            \ link."
           type: object
           allOf:
           - $ref: '#/components/schemas/UserRepresentation'

diff --git a/...ultanov/keycloak/multitenancy/resource/representation/TenantMembershipRepresentation.java b/...ultanov/keycloak/multitenancy/resource/representation/TenantMembershipRepresentation.java
@@ -12,7 +12,7 @@ public class TenantMembershipRepresentation {
     @Schema(readOnly = true)
     private String id;
 
-    @Schema(readOnly = true)
+    @Schema(readOnly = true, description = "Returns basic user info only including id, username, creation date, names, email, enabled state, email verification and federation link.")
     private UserRepresentation user;
 
     @Schema(required = true)