Document the valid values for the "set_presence" parameter

9 years ago · c115b4c2f4
parent 940e22940d
commit c115b4c2f4
1 changed files with 7 additions and 2 deletions
--- a/api/client-server/v2_alpha/sync.yaml
+++ b/api/client-server/v2_alpha/sync.yaml
@ -43,9 +43,14 @@ paths:
        - in: query
          name: set_presence
          type: string
+          enum: ["offline"]
          description: |-
-            Set the presence status of this client.
-          x-example: "online"
+            Controls whether the client is automatically marked as online by
+            polling this API. If this parameter is omitted then the client is
+            automatically marked as online when it uses this API. Otherwise if
+            the parameter is set to "offline" then the client is not marked as
+            being online when it uses this API.
+          x-example: "offline"
        - in: query
          name: timeout
          type: integer