refactor: WorldID/InstanceID/LocationID

Author: Hackebein

openapi/components/responses/instances/LocationIDListResponse.yaml

@@ -0,0 +1,7 @@
+description: Returns a list of LocationIDs.
+content:
+  application/json:
+    schema:
+      type: array
+      items:
+        $ref: ../../schemas/LocationID.yaml

openapi/components/responses/instances/LocationListResponse.yaml

@@ -42,7 +42,7 @@ properties:
     type: string
     nullable: true
   travelingToWorld:
-    $ref: ./WorldID.yaml
+    $ref: ./LocationID.yaml
     nullable: true
   userIcon:
     type: string

openapi/components/schemas/CurrentUserPresence.yaml

@@ -2,11 +2,9 @@ title: GroupInstance
 type: object
 properties:
   instanceId:
-    type: string
-    minLength: 1
-    example: 12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)
-  location:
     $ref: ./InstanceID.yaml
+  location:
+    $ref: ./LocationID.yaml
   world:
     $ref: ./World.yaml
   memberCount:

openapi/components/schemas/GroupInstance.yaml

@@ -38,14 +38,12 @@ properties:
   id:
     $ref: ./InstanceID.yaml
   instanceId:
-    type: string
-    minLength: 1
-    example: 12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)
+    $ref: ./InstanceID.yaml
   instancePersistenceEnabled:
     type: string
     nullable: true
   location:
-    $ref: ./InstanceID.yaml
+    $ref: ./LocationID.yaml
   n_users:
     type: integer
     minimum: 0

openapi/components/schemas/Instance.yaml

@@ -0,0 +1,4 @@
+type: string
+example: 'wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)'
+title: LocationID
+description: LocationID is a combination of WorldID and InstanceID connected by a colon (WorldID:InstanceID). LocationID will be "offline" on User profiles if you are not friends with that user.

openapi/components/schemas/Location.yaml

@@ -2,7 +2,7 @@ properties:
   inviteMessage:
     type: string
   worldId:
-    $ref: ./WorldID.yaml
+    $ref: ./LocationID.yaml
   worldName:
     type: string
 required:

openapi/components/schemas/LocationID.yaml

@@ -60,7 +60,7 @@ properties:
   last_platform:
     $ref: ./Platform.yaml
   location:
-    $ref: ./WorldID.yaml
+    $ref: ./LocationID.yaml
   note:
     type: string
   platform: