Economy, jam, world, and misc endpoints

openapi/components/parameters.yaml

@@ -62,7 +62,7 @@
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/BadgeID.yaml
 branch:
   name: branch
   description: Specifies which git branch the site should load frontend source code from.
@@ -163,8 +163,7 @@
   required: true
   in: path
   schema:
-    type: string
-    example: cal_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/CalendarID.yaml
 calendarSearchTerm:
   name: searchTerm
   description: Search term for calendar events.
@@ -187,15 +186,30 @@
   required: true
   in: query
   schema:
-    type: string
-    example: usr_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/UserID.yaml
 contentId:
   name: contentId
-  description: Filter for users' previously submitted feedback, e.g., a groupId, userId, avatarId, etc.
+  description: Filter for particular content submitted, e.g., a groupId, userId, avatarId, etc.
   required: false
   in: query
   schema:
-    type: boolean
+    type: string
+dateMax:
+  name: dateMax
+  description: The end date of the search range.
+  required: false
+  in: query
+  schema:
+    type: string
+    format: date-time
+dateMin:
+  name: dateMin
+  description: The start date of the search range.
+  required: false
+  in: query
+  schema:
+    type: string
+    format: date-time
 displayName:
   name: displayName
   description: Filter by displayName.
@@ -232,32 +246,28 @@
   required: false
   in: query
   schema:
-    type: string
+    $ref: ./schemas/UserID.yaml
 favoriteGroupName:
   name: favoriteGroupName
   description: "The name of the group to fetch, must be a name of a FavoriteGroup."
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/FavoriteName.yaml
 favoriteGroupType:
   name: favoriteGroupType
   description: "The type of group to fetch, must be a valid FavoriteType."
   required: true
   in: path
   schema:
-    type: string
-    enum:
-      - avatar
-      - friend
-      - world
+    $ref: ./schemas/FavoriteType.yaml
 favoriteId:
   name: favoriteId
   description: Must be a valid favorite ID.
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/FavoriteID.yaml
 featured:
   name: featured
   description: Filters on featured results.
@@ -271,8 +281,7 @@
   required: true
   in: path
   schema:
-    type: string
-    example: file_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/FileID.yaml
 fileType:
   name: fileType
   description: Type of file.
@@ -285,44 +294,47 @@
       - file
       - signature
     example: file
+fromUserId:
+  name: fromUserId
+  description: Must be a valid user ID.
+  required: false
+  in: query
+  schema:
+    $ref: ./schemas/UserID.yaml
 fuzzy:
   name: fuzzy
   required: false
   in: query
   schema:
     type: boolean
 groupGalleryId:
   name: groupGalleryId
   description: Must be a valid group gallery ID.
   required: true
   in: path
   schema:
-    type: string
-    example: ggal_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/GroupGalleryID.yaml
 groupGalleryImageId:
   name: groupGalleryImageId
   description: Must be a valid group gallery image ID.
   required: true
   in: path
   schema:
-    type: string
-    example: ggim_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/GroupGalleryImageID.yaml
 groupId:
   name: groupId
   description: Must be a valid group ID.
   required: true
   in: path
   schema:
-    type: string
-    example: grp_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/GroupID.yaml
 groupIdFilter:
   name: groupId
   description: Must be a valid group ID.
   required: false
   in: query
   schema:
-    type: string
-    example: grp_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/GroupID.yaml
 groupMemberRoleFilter:
   name: roleId
   description: Only returns members with a specific groupRoleId
@@ -343,8 +355,7 @@
   required: true
   in: path
   schema:
-    type: string
-    example: grol_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/GroupRoleID.yaml
 hydrate:
   name: hydrate
   description: Populates some fields and changes types of others for certain objects.
@@ -379,7 +390,7 @@
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/InstanceID.yaml
 inventoryEquipSlot:
   name: equipSlot
   description: Filter for inventory retrieval.
@@ -414,8 +425,7 @@
   required: true
   in: path
   schema:
-    type: string
-    example: inv_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/InventoryItemID.yaml
 inventoryItemNotFlags:
   name: notFlags
   description: Filter out flags for inventory retrieval (comma-separated).
@@ -453,7 +463,7 @@
     $ref: ./schemas/InventoryItemType.yaml
 inventoryPedestalDuration:
   name: duration
   description: The duration before the sharing pedestal despawns.
   required: true
   in: query
   schema:
@@ -493,8 +503,7 @@
   required: true
   in: path
   schema:
-    type: string
-    example: invt_00000000-0000-0000-0000-000000000000
+    $ref: ./schemas/InventoryTemplateID.yaml
 isInternalVariant:
   name: isInternalVariant
   description: Not quite sure what this actually does (exists on the website but doesn't seem to be used)
@@ -505,19 +514,25 @@
     example: false
 jamId:
   name: jamId
-  description: Must be a valid query ID.
+  description: Must be a valid jam ID.
   required: true
   in: path
   schema:
-    type: string
-    example: jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9
+    $ref: ./schemas/JamID.yaml
+jamSubmissionId:
+  name: jamSubmissionId
+  description: Must be a valid jam submission ID.
+  required: true
+  in: path
+  schema:
+    $ref: ./schemas/JamSubmissionID.yaml
 licenseGroupId:
   name: licenseGroupId
   description: Must be a valid license group ID.
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/LicenseGroupID.yaml
 limit:
   name: limit
   description: The maximum number of entries to get.
@@ -540,6 +555,13 @@
   in: path
   schema:
     $ref: ./schemas/InviteMessageType.yaml
+metadata:
+  name: metadata
+  description: Which metadata fields to include (comma-separated).
+  required: false
+  in: query
+  schema:
+    type: string
 minUnityVersion:
   name: minUnityVersion
   description: The minimum Unity version supported by the asset.
@@ -583,12 +605,12 @@
   schema:
     type: string
     format: date-time
 mostRecentFlag:
   name: mostRecent
   required: false
   in: query
   schema:
     type: boolean
 noplatform:
   name: noplatform
   description: The platform the asset does not support.
@@ -609,7 +631,7 @@
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/NotificationID.yaml
 number:
   name: n
   description: The number of objects to return.
@@ -655,7 +677,7 @@
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/PermissionID.yaml
 platform:
   name: platform
   description: The platform the asset supports.
@@ -669,23 +691,35 @@
   required: true
   in: path
   schema:
-    type: string
-    example: prnt_0a0aa0a0-85ea-42eb-b2f7-4840d7f341fa
+    $ref: ./schemas/PrintID.yaml
 productId:
   name: productId
   description: Must be a valid product ID.
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/ProductID.yaml
+productPurchaseId:
+  name: productPurchaseId
+  description: Must be a valid purchase ID.
+  required: true
+  in: path
+  schema:
+    $ref: ./schemas/ProductPurchaseID.yaml
 propId:
   name: propId
   description: Prop ID.
   required: true
   in: path
   schema:
-    type: string
-    example: prop_829ba6f6-b837-49d9-b9a9-056b82103b58
+    $ref: ./schemas/PropID.yaml
+publishedPlatform:
+  name: publishedPlatform
+  description: A platform the world supports.
+  required: true
+  in: path
+  schema:
+    $ref: ./schemas/Platform.yaml
 releaseStatus:
   name: releaseStatus
   description: Filter by ReleaseStatus.
@@ -746,18 +780,25 @@
   schema:
     type: string
     example: game night
 storeId:
   name: storeId
   required: true
   in: query
   schema:
     $ref: ./schemas/StoreID.yaml
 storeView:
   name: fetch
   required: false
   in: query
   schema:
     $ref: ./schemas/StoreView.yaml
+submitterId:
+  name: submitterId
+  description: Must be a valid user ID.
+  required: false
+  in: query
+  schema:
+    $ref: ./schemas/UserID.yaml
 subscriptionId:
   name: subscriptionId
   required: true
@@ -786,6 +827,13 @@
   schema:
     type: string
     example: usr_00000000-0000-0000-0000-000000000000,usr_11111111-1111-1111-1111-111111111111
+toUserId:
+  name: toUserId
+  description: Must be a valid user ID.
+  required: false
+  in: query
+  schema:
+    $ref: ./schemas/UserID.yaml
 transactionId:
   name: transactionId
   description: Must be a valid transaction ID.
@@ -799,28 +847,28 @@
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/UserID.yaml
 userIdAdmin:
   name: userId
   description: "Target user to see information on, admin-only."
   required: false
   in: query
   schema:
-    type: string
+    $ref: ./schemas/UserID.yaml
 userIdQuery:
   name: userId
   description: Filter by UserID.
   required: false
   in: query
   schema:
-    type: string
+    $ref: ./schemas/UserID.yaml
 userNoteId:
   name: userNoteId
   description: Must be a valid user note ID.
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/UserNoteID.yaml
 usernameQuery:
   name: username
   description: Filter by Username.
@@ -871,4 +919,4 @@
   required: true
   in: path
   schema:
-    type: string
+    $ref: ./schemas/WorldID.yaml