Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add favorited world schema #396

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion openapi/components/paths/worlds.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ paths:
$ref: "../codeSamples/worlds.yaml#/~1worlds~1favorites/get"
responses:
'200':
$ref: ../responses/worlds/LimitedWorldListResponse.yaml
$ref: ../responses/worlds/FavoritedWorldListResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
'403':
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
description: Returns a list of FavoritedWorld objects.
content:
application/json:
schema:
type: array
items:
$ref: ../../schemas/FavoritedWorld.yaml
132 changes: 132 additions & 0 deletions openapi/components/schemas/FavoritedWorld.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
description: ''
properties:
authorId:
$ref: ./UserID.yaml
authorName:
minLength: 1
type: string
capacity:
example: 8
type: integer
description:
minLength: 1
type: string
recommendedCapacity:
example: 16
type: integer
created_at:
format: date-time
type: string
favorites:
default: 0
example: 12024
minimum: 0
type: integer
favoriteGroup:
minLength: 1
type: string
favoriteId:
$ref: ./FavoriteID.yaml
featured:
default: false
type: boolean
visits:
default: 0
example: 9988675
minimum: 0
type: integer
heat:
default: 0
example: 5
minimum: 0
type: integer
id:
$ref: ./WorldID.yaml
imageUrl:
minLength: 1
type: string
labsPublicationDate:
example: none
minLength: 1
type: string
name:
minLength: 1
type: string
occupants:
default: 0
example: 47
minimum: 0
type: integer
organization:
default: vrchat
minLength: 1
type: string
popularity:
default: 0
example: 8
minimum: 0
type: integer
previewYoutubeId:
type: string
nullable: true
publicationDate:
example: none
minLength: 1
type: string
releaseStatus:
$ref: ./ReleaseStatus.yaml
storeId:
type: string
nullable: true
tags:
description: ' '
items:
$ref: ./Tag.yaml
type: array
thumbnailImageUrl:
minLength: 1
type: string
unityPackages:
description: ' '
items:
$ref: ./UnityPackage.yaml
minItems: 1
type: array
updated_at:
format: date-time
type: string
udonProducts:
type: array
items:
$ref: ./UdonProductId.yaml
version:
minimum: 1
type: integer
required:
- id
- description
- name
- authorId
- authorName
- capacity
- imageUrl
- thumbnailImageUrl
- releaseStatus
- storeId
- organization
- tags
- favorites
- favoriteGroup
- favoriteId
- featured
- created_at
- updated_at
- publicationDate
- labsPublicationDate
- unityPackages
- popularity
- heat
- occupants
- version
title: FavoritedWorld
type: object