vrchatapi-specification/openapi/components/paths/avatars.yaml at b6f70ee7522b682963fc518c573bd631f266863e · VinyarionHyarmendacil/vrchatapi-specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
openapi: 3.0.3
info:
  title: avatars
  description: Avatars Docs Here
  version: "1.0"
paths:
  /avatarStyles:
    get:
      operationId: getAvatarStyles
      summary: Get Avatar Styles
      description: List avatar styles.
      tags:
        - avatars
      responses:
        "200":
          $ref: ../responses/avatars/AvatarStyleListResponse.yaml
  /avatars:
    get:
      operationId: searchAvatars
      summary: Search Avatars
      description: Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.
      tags:
        - avatars
      parameters:
        - $ref: ../parameters.yaml#/featured
        - $ref: ../parameters.yaml#/sort
        - name: user
          description: Set to `me` for searching own avatars.
          required: false
          in: query
          schema:
            type: string
            enum:
              - me
        - $ref: ../parameters.yaml#/userIdQuery
        - $ref: ../parameters.yaml#/number
        - $ref: ../parameters.yaml#/order
        - $ref: ../parameters.yaml#/offset
        - $ref: ../parameters.yaml#/tag
        - $ref: ../parameters.yaml#/notag
        - $ref: ../parameters.yaml#/releaseStatus
        - $ref: ../parameters.yaml#/maxUnityVersion
        - $ref: ../parameters.yaml#/minUnityVersion
        - $ref: ../parameters.yaml#/platform
        - $ref: ../parameters.yaml#/isInternalVariant
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarListResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
    post:
      operationId: createAvatar
      summary: Create Avatar
      description: Create an avatar. It's possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.
      tags:
        - avatars
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../requests/CreateAvatarRequest.yaml
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarResponse.yaml
        "400":
          $ref: ../responses/avatars/UnableToCreateAvatarNowError.yaml
        "401":
          $ref: ../responses/FeaturedSetNotAdminError.yaml
  /avatars/favorites:
    get:
      operationId: getFavoritedAvatars
      summary: List Favorited Avatars
      description: Search and list favorited avatars by query filters.
      tags:
        - avatars
      parameters:
        - $ref: ../parameters.yaml#/featured
        - $ref: ../parameters.yaml#/sort
        - $ref: ../parameters.yaml#/number
        - $ref: ../parameters.yaml#/order
        - $ref: ../parameters.yaml#/offset
        - $ref: ../parameters.yaml#/search
        - $ref: ../parameters.yaml#/tag
        - $ref: ../parameters.yaml#/notag
        - $ref: ../parameters.yaml#/releaseStatus
        - $ref: ../parameters.yaml#/maxUnityVersion
        - $ref: ../parameters.yaml#/minUnityVersion
        - $ref: ../parameters.yaml#/platform
        - $ref: ../parameters.yaml#/userIdAdmin
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarListResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "403":
          $ref: ../responses/avatars/AvatarSeeOtherUserFavoritesError.yaml
  /avatars/impostor/queue/stats:
    get:
      operationId: getImpostorQueueStats
      summary: Get Impostor Queue Stats
      description: Gets service stats for queued impostor.
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarImpostorQueueStatsResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
  /avatars/licensed:
    get:
      operationId: getLicensedAvatars
      summary: List Licensed Avatars
      description: List licensed avatars.
      tags:
        - avatars
      parameters:
        - $ref: ../parameters.yaml#/number
        - $ref: ../parameters.yaml#/offset
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarListResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
  "/avatars/{avatarId}":
    parameters:
      - $ref: ../parameters.yaml#/avatarId
    get:
      operationId: getAvatar
      summary: Get Avatar
      description: Get information about a specific Avatar.
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "404":
          $ref: ../responses/avatars/AvatarNotFoundError.yaml
    put:
      operationId: updateAvatar
      summary: Update Avatar
      description: Update information about a specific avatar.
      tags:
        - avatars
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../requests/UpdateAvatarRequest.yaml
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "404":
          $ref: ../responses/avatars/AvatarNotFoundError.yaml
    delete:
      operationId: deleteAvatar
      summary: Delete Avatar
      description: 'Delete an avatar. Notice an avatar is never fully "deleted", only its ReleaseStatus is set to "hidden" and the linked Files are deleted. The AvatarID is permanently reserved.'
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "404":
          $ref: ../responses/avatars/AvatarNotFoundError.yaml
  "/avatars/{avatarId}/impostor":
    parameters:
      - $ref: ../parameters.yaml#/avatarId
    delete:
      operationId: deleteImpostor
      summary: Delete generated Impostor
      description: Delete generated Impostor for that avatar.
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          description: The Impostors generated for that avatar are deleted.
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "404":
          $ref: ../responses/avatars/AvatarNotFoundError.yaml
  "/avatars/{avatarId}/impostor/enqueue":
    parameters:
      - $ref: ../parameters.yaml#/avatarId
    post:
      operationId: enqueueImpostor
      summary: Enqueue Impostor generation
      description: Enqueue Impostor generation for that avatar.
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarImpostorEnqueueResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "404":
          $ref: ../responses/avatars/AvatarNotFoundError.yaml
  "/avatars/{avatarId}/select":
    parameters:
      - $ref: ../parameters.yaml#/avatarId
    put:
      operationId: selectAvatar
      summary: Select Avatar
      description: Switches into that avatar.
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/users/CurrentUserResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "404":
          $ref: ../responses/avatars/AvatarNotFoundError.yaml
  "/avatars/{avatarId}/selectFallback":
    parameters:
      - $ref: ../parameters.yaml#/avatarId
    put:
      operationId: selectFallbackAvatar
      deprecated: true
      summary: Select Fallback Avatar
      description: Switches into that avatar as your fallback avatar.
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/users/CurrentUserResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "403":
          $ref: ../responses/avatars/AvatarNotTaggedAsFallbackError.yaml
        "404":
          $ref: ../responses/avatars/AvatarNotFoundError.yaml
  "/users/{userId}/avatar":
    parameters:
      - $ref: ../parameters.yaml#/userId
    get:
      operationId: getOwnAvatar
      summary: Get Own Avatar
      description: Get the current avatar for the user. This will return an error for any other user than the one logged in.
      tags:
        - avatars
      security:
        - authCookie: []
      responses:
        "200":
          $ref: ../responses/avatars/AvatarResponse.yaml
        "401":
          $ref: ../responses/MissingCredentialsError.yaml
        "403":
          $ref: ../responses/avatars/AvatarSeeOtherUserCurrentAvatarError.yaml
components:
  securitySchemes:
    $ref: ../securitySchemes.yaml
tags:
  $ref: ../tags.yaml