Changes to ListWorlds

avail · web-flow · commit 3ecf35c53daa · 2018-10-11T08:38:38.000+02:00
Added some fields and reworded a few things
diff --git a/WorldAPI/ListWorlds.md b/WorldAPI/ListWorlds.md
@@ -30,31 +30,27 @@ Field | Type | Optional | Description
 ------|------|----------|------------
 featured | bool | yes | is the world featured
 sort | `SortOptions` | yes | How to sort the worlds
-user | `UserOptions` | yes | who the creator may be
+user | string | yes | Set to `me` for searching own worlds
 userId | string | yes | Filter by creator id, use `me` for only worlds owned by current user
-n | int | yes | How many users to return
-offset | int | yes | How many users to skip
+n | int | yes | How many worlds to return
+order | `OrderOptions` | yes | Result ordering
+offset | int | yes | How many worlds to skip
 search | string | yes | Filter by name
 tag | Comma seperated strings | yes | Filter by tag
 notag | Comma seperated strings | Tags to exclude 
 releaseStatus | `ReleaseStatus` | yes | Filter by release status
-maxUnityVersion | string | yes | The max unity version the world support
+maxUnityVersion | string | yes | Current unity version the game is using
 minUnityVersion | string | yes | The min unity version the world support
-maxAssetVersion | string | yes | The max asset version the world support
+maxAssetVersion | string | yes | Current asset version the game is using
 minAssetVersion | string | yes | The min asset version the world support
-platform | string | yes | The platform the world support
+platform | string | yes | The platform the world supports (usually standalonewindows)
 
 Featured are set as:
     - sort=order, featured=true
 
 Trending is set as:
     - sort=popularity, featured=false
 
-### UserOptions
-
-    - me
-    - friends
-
 ### SortOptions
 
     - popularity
@@ -63,6 +59,10 @@ Trending is set as:
     - order
     - _created_at
     - _updated_at
+    
+### OrderOptions
+    - ascending
+    - descending
 
 ## Returns 
 
@@ -71,10 +71,11 @@ Array of:
 Field | Type | Description
 ------|------|------------
 id | string | World ID
-name | string | World Name
+name | string | World name
 authorName | string | The name of the creator
-totalLikes | int | How many likes this world has
-totalVisits | int | How many visits this world has
+totalLikes | int | How many likes the world has
+totalVisits | int | How many visits the world has
+capacity | int | World player limit
 imageUrl | string | URL to the image of the world
 thumbnailImageURL | string | URL to the image of the world (small)
 isSecure | boolean | unknown (probably password?)
