Skip to content

Commit 1c9c814

Browse files
Economy, jam, world, and misc endpoints (#569)
* Economy, jam, world, and misc endpoints Renamed `Submission` to `JamSubmission` Renamed *file* `representedGroup` to `RepresentedGroup` Added: - `GET /economy/metrics/earnings` - `GET /economy/purchases/{productPurchaseId}` - `GET /economy/purchases/{productPurchaseId}/stacks` - `GET /economy/seller/eligibility` - `POST /jams/{jamId}/submissions` - `DELETE /jams/{jamId}/submissions/{jamSubmissionId}` - `POST /reward/redeem` - `GET /user/{userId}/economy/transactions` - `GET /users/{userId}/tutorial` - `POST /worlds/{worldId}/addTags` - `DELETE /worlds/{worldId}/platform/{publishedPlatform}` - `POST /worlds/{worldId}/removeTags` Updated: - `POST /economy/purchase/listing` - `GET /jams/{jamId}/submissions` * lint 0 * yay windows is case insensitive for files yay * a rubber room filled with rats * why lint not catch things that actually matter crying emoji * ​ * it has been a day * incorrect schema title
1 parent a213c34 commit 1c9c814

39 files changed

Lines changed: 695 additions & 70 deletions

openapi/components/parameters.yaml

Lines changed: 96 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ badgeId:
6262
required: true
6363
in: path
6464
schema:
65-
type: string
65+
$ref: ./schemas/BadgeID.yaml
6666
branch:
6767
name: branch
6868
description: Specifies which git branch the site should load frontend source code from.
@@ -163,8 +163,7 @@ calendarId:
163163
required: true
164164
in: path
165165
schema:
166-
type: string
167-
example: cal_00000000-0000-0000-0000-000000000000
166+
$ref: ./schemas/CalendarID.yaml
168167
calendarSearchTerm:
169168
name: searchTerm
170169
description: Search term for calendar events.
@@ -187,15 +186,30 @@ confirmEmailUserId:
187186
required: true
188187
in: query
189188
schema:
190-
type: string
191-
example: usr_00000000-0000-0000-0000-000000000000
189+
$ref: ./schemas/UserID.yaml
192190
contentId:
193191
name: contentId
194-
description: Filter for users' previously submitted feedback, e.g., a groupId, userId, avatarId, etc.
192+
description: Filter for particular content submitted, e.g., a groupId, userId, avatarId, etc.
195193
required: false
196194
in: query
197195
schema:
198-
type: boolean
196+
type: string
197+
dateMax:
198+
name: dateMax
199+
description: The end date of the search range.
200+
required: false
201+
in: query
202+
schema:
203+
type: string
204+
format: date-time
205+
dateMin:
206+
name: dateMin
207+
description: The start date of the search range.
208+
required: false
209+
in: query
210+
schema:
211+
type: string
212+
format: date-time
199213
displayName:
200214
name: displayName
201215
description: Filter by displayName.
@@ -232,32 +246,28 @@ excludeUserId:
232246
required: false
233247
in: query
234248
schema:
235-
type: string
249+
$ref: ./schemas/UserID.yaml
236250
favoriteGroupName:
237251
name: favoriteGroupName
238252
description: "The name of the group to fetch, must be a name of a FavoriteGroup."
239253
required: true
240254
in: path
241255
schema:
242-
type: string
256+
$ref: ./schemas/FavoriteName.yaml
243257
favoriteGroupType:
244258
name: favoriteGroupType
245259
description: "The type of group to fetch, must be a valid FavoriteType."
246260
required: true
247261
in: path
248262
schema:
249-
type: string
250-
enum:
251-
- avatar
252-
- friend
253-
- world
263+
$ref: ./schemas/FavoriteType.yaml
254264
favoriteId:
255265
name: favoriteId
256266
description: Must be a valid favorite ID.
257267
required: true
258268
in: path
259269
schema:
260-
type: string
270+
$ref: ./schemas/FavoriteID.yaml
261271
featured:
262272
name: featured
263273
description: Filters on featured results.
@@ -271,8 +281,7 @@ fileId:
271281
required: true
272282
in: path
273283
schema:
274-
type: string
275-
example: file_00000000-0000-0000-0000-000000000000
284+
$ref: ./schemas/FileID.yaml
276285
fileType:
277286
name: fileType
278287
description: Type of file.
@@ -285,6 +294,13 @@ fileType:
285294
- file
286295
- signature
287296
example: file
297+
fromUserId:
298+
name: fromUserId
299+
description: Must be a valid user ID.
300+
required: false
301+
in: query
302+
schema:
303+
$ref: ./schemas/UserID.yaml
288304
fuzzy:
289305
name: fuzzy
290306
required: false
@@ -297,32 +313,28 @@ groupGalleryId:
297313
required: true
298314
in: path
299315
schema:
300-
type: string
301-
example: ggal_00000000-0000-0000-0000-000000000000
316+
$ref: ./schemas/GroupGalleryID.yaml
302317
groupGalleryImageId:
303318
name: groupGalleryImageId
304319
description: Must be a valid group gallery image ID.
305320
required: true
306321
in: path
307322
schema:
308-
type: string
309-
example: ggim_00000000-0000-0000-0000-000000000000
323+
$ref: ./schemas/GroupGalleryImageID.yaml
310324
groupId:
311325
name: groupId
312326
description: Must be a valid group ID.
313327
required: true
314328
in: path
315329
schema:
316-
type: string
317-
example: grp_00000000-0000-0000-0000-000000000000
330+
$ref: ./schemas/GroupID.yaml
318331
groupIdFilter:
319332
name: groupId
320333
description: Must be a valid group ID.
321334
required: false
322335
in: query
323336
schema:
324-
type: string
325-
example: grp_00000000-0000-0000-0000-000000000000
337+
$ref: ./schemas/GroupID.yaml
326338
groupMemberRoleFilter:
327339
name: roleId
328340
description: Only returns members with a specific groupRoleId
@@ -343,8 +355,7 @@ groupRoleId:
343355
required: true
344356
in: path
345357
schema:
346-
type: string
347-
example: grol_00000000-0000-0000-0000-000000000000
358+
$ref: ./schemas/GroupRoleID.yaml
348359
hydrate:
349360
name: hydrate
350361
description: Populates some fields and changes types of others for certain objects.
@@ -379,7 +390,7 @@ instanceId:
379390
required: true
380391
in: path
381392
schema:
382-
type: string
393+
$ref: ./schemas/InstanceID.yaml
383394
inventoryEquipSlot:
384395
name: equipSlot
385396
description: Filter for inventory retrieval.
@@ -414,8 +425,7 @@ inventoryItemId:
414425
required: true
415426
in: path
416427
schema:
417-
type: string
418-
example: inv_00000000-0000-0000-0000-000000000000
428+
$ref: ./schemas/InventoryItemID.yaml
419429
inventoryItemNotFlags:
420430
name: notFlags
421431
description: Filter out flags for inventory retrieval (comma-separated).
@@ -493,8 +503,7 @@ inventoryTemplateId:
493503
required: true
494504
in: path
495505
schema:
496-
type: string
497-
example: invt_00000000-0000-0000-0000-000000000000
506+
$ref: ./schemas/InventoryTemplateID.yaml
498507
isInternalVariant:
499508
name: isInternalVariant
500509
description: Not quite sure what this actually does (exists on the website but doesn't seem to be used)
@@ -505,19 +514,25 @@ isInternalVariant:
505514
example: false
506515
jamId:
507516
name: jamId
508-
description: Must be a valid query ID.
517+
description: Must be a valid jam ID.
509518
required: true
510519
in: path
511520
schema:
512-
type: string
513-
example: jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9
521+
$ref: ./schemas/JamID.yaml
522+
jamSubmissionId:
523+
name: jamSubmissionId
524+
description: Must be a valid jam submission ID.
525+
required: true
526+
in: path
527+
schema:
528+
$ref: ./schemas/JamSubmissionID.yaml
514529
licenseGroupId:
515530
name: licenseGroupId
516531
description: Must be a valid license group ID.
517532
required: true
518533
in: path
519534
schema:
520-
type: string
535+
$ref: ./schemas/LicenseGroupID.yaml
521536
limit:
522537
name: limit
523538
description: The maximum number of entries to get.
@@ -540,6 +555,13 @@ messageType:
540555
in: path
541556
schema:
542557
$ref: ./schemas/InviteMessageType.yaml
558+
metadata:
559+
name: metadata
560+
description: Which metadata fields to include (comma-separated).
561+
required: false
562+
in: query
563+
schema:
564+
type: string
543565
minUnityVersion:
544566
name: minUnityVersion
545567
description: The minimum Unity version supported by the asset.
@@ -609,7 +631,7 @@ notificationId:
609631
required: true
610632
in: path
611633
schema:
612-
type: string
634+
$ref: ./schemas/NotificationID.yaml
613635
number:
614636
name: n
615637
description: The number of objects to return.
@@ -655,7 +677,7 @@ permissionId:
655677
required: true
656678
in: path
657679
schema:
658-
type: string
680+
$ref: ./schemas/PermissionID.yaml
659681
platform:
660682
name: platform
661683
description: The platform the asset supports.
@@ -669,23 +691,35 @@ printId:
669691
required: true
670692
in: path
671693
schema:
672-
type: string
673-
example: prnt_0a0aa0a0-85ea-42eb-b2f7-4840d7f341fa
694+
$ref: ./schemas/PrintID.yaml
674695
productId:
675696
name: productId
676697
description: Must be a valid product ID.
677698
required: true
678699
in: path
679700
schema:
680-
type: string
701+
$ref: ./schemas/ProductID.yaml
702+
productPurchaseId:
703+
name: productPurchaseId
704+
description: Must be a valid purchase ID.
705+
required: true
706+
in: path
707+
schema:
708+
$ref: ./schemas/ProductPurchaseID.yaml
681709
propId:
682710
name: propId
683711
description: Prop ID.
684712
required: true
685713
in: path
686714
schema:
687-
type: string
688-
example: prop_829ba6f6-b837-49d9-b9a9-056b82103b58
715+
$ref: ./schemas/PropID.yaml
716+
publishedPlatform:
717+
name: publishedPlatform
718+
description: A platform the world supports.
719+
required: true
720+
in: path
721+
schema:
722+
$ref: ./schemas/Platform.yaml
689723
releaseStatus:
690724
name: releaseStatus
691725
description: Filter by ReleaseStatus.
@@ -758,6 +792,13 @@ storeView:
758792
in: query
759793
schema:
760794
$ref: ./schemas/StoreView.yaml
795+
submitterId:
796+
name: submitterId
797+
description: Must be a valid user ID.
798+
required: false
799+
in: query
800+
schema:
801+
$ref: ./schemas/UserID.yaml
761802
subscriptionId:
762803
name: subscriptionId
763804
required: true
@@ -786,6 +827,13 @@ targetIds:
786827
schema:
787828
type: string
788829
example: usr_00000000-0000-0000-0000-000000000000,usr_11111111-1111-1111-1111-111111111111
830+
toUserId:
831+
name: toUserId
832+
description: Must be a valid user ID.
833+
required: false
834+
in: query
835+
schema:
836+
$ref: ./schemas/UserID.yaml
789837
transactionId:
790838
name: transactionId
791839
description: Must be a valid transaction ID.
@@ -799,28 +847,28 @@ userId:
799847
required: true
800848
in: path
801849
schema:
802-
type: string
850+
$ref: ./schemas/UserID.yaml
803851
userIdAdmin:
804852
name: userId
805853
description: "Target user to see information on, admin-only."
806854
required: false
807855
in: query
808856
schema:
809-
type: string
857+
$ref: ./schemas/UserID.yaml
810858
userIdQuery:
811859
name: userId
812860
description: Filter by UserID.
813861
required: false
814862
in: query
815863
schema:
816-
type: string
864+
$ref: ./schemas/UserID.yaml
817865
userNoteId:
818866
name: userNoteId
819867
description: Must be a valid user note ID.
820868
required: true
821869
in: path
822870
schema:
823-
type: string
871+
$ref: ./schemas/UserNoteID.yaml
824872
usernameQuery:
825873
name: username
826874
description: Filter by Username.
@@ -871,4 +919,4 @@ worldId:
871919
required: true
872920
in: path
873921
schema:
874-
type: string
922+
$ref: ./schemas/WorldID.yaml

0 commit comments

Comments
 (0)