fix remaining title and following fields

lichess-org · Apr 12, 2024 · 6b21b74 · 6b21b74
1 parent c63510e
commit 6b21b74
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/doc/specs/schemas/Title.yaml b/doc/specs/schemas/Title.yaml
@@ -1,3 +1,4 @@
 type: string
 enum: [GM, WGM, IM, WIM, FM, WFM, NM, CM, WCM, WNM, LM, BOT]
 example: NM
+description: only appears if the user is a titled player or a bot user
diff --git a/doc/specs/schemas/UserExtended.yaml b/doc/specs/schemas/UserExtended.yaml
@@ -26,13 +26,18 @@ allOf:
       followable:
         type: boolean
         example: true
+        description: only appears if the request is [authenticated with OAuth2](#section/Introduction/Authentication)
       following:
         type: boolean
         example: false
+        description: only appears if the request is [authenticated with OAuth2](#section/Introduction/Authentication)
       blocking:
         type: boolean
         example: false
+        description: only appears if the request is [authenticated with OAuth2](#section/Introduction/Authentication)
       followsYou:
         type: boolean
         example: false
+        description: only appears if the request is [authenticated with OAuth2](#section/Introduction/Authentication)
+
 
diff --git a/doc/specs/tags/users/api-user-username.yaml b/doc/specs/tags/users/api-user-username.yaml
@@ -3,8 +3,6 @@ get:
   summary: Get user public data
   description: |
     Read public data of a user.
-    If the request is [authenticated with OAuth2](#section/Introduction/Authentication),
-    then extra fields might be present in the response: `followable`, `following`, `blocking`, `followsYou`.
   tags:
     - Users
   security: