Skip to content
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: 2 additions & 0 deletions openapi/components/paths/miscellaneous.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/auth/permissions:
parameters: []
get:
operationId: getAssignedPermissions

Check notice on line 10 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listAssignedPermissions.
summary: Get Assigned Permissions
description: Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
tags:
Expand Down Expand Up @@ -35,7 +35,7 @@
$ref: ../responses/system/APIConfigResponse.yaml
/css/app.css:
get:
operationId: getCSS

Check notice on line 38 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Consider renaming to getCss.
summary: Download CSS
description: Fetches the CSS code to the frontend React website.
tags:
Expand Down Expand Up @@ -69,7 +69,7 @@
$ref: ../responses/system/APIHealthResponse.yaml
/infoPush:
get:
operationId: getInfoPush

Check notice on line 72 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listInfoPushes.
summary: Show Information Notices
description: |-
IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version.
Expand All @@ -82,6 +82,8 @@
parameters:
- $ref: ../parameters.yaml#/require
- $ref: ../parameters.yaml#/include
security:
- authCookie: []
responses:
"200":
$ref: ../responses/system/InfoPushListResponse.yaml
Expand Down Expand Up @@ -109,7 +111,7 @@
$ref: ../responses/system/DownloadSourceCodeAccessError.yaml
/permissions:
get:
operationId: getPermissions

Check notice on line 114 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listPermissions.
summary: Get Permissions
description: "**REQUIRES ADMIN CREDENTIALS**. Returns a list of all existing permissions, just like `/users` with empty search would."
tags:
Expand Down Expand Up @@ -142,15 +144,15 @@
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
ownerId:
$ref: ../schemas/UserID.yaml
required:
- name

Check warning on line 155 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
security:
- authCookie: []
responses:
Expand All @@ -172,8 +174,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/permissions/PermissionResponse.yaml

Check warning on line 178 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.

Check warning on line 178 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
put:
Expand All @@ -184,21 +186,21 @@
tags:
- miscellaneous
requestBody:
description: ""

Check warning on line 189 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
content:
application/json:
schema:
type: object
properties:
name:
type: string
ownerId:
$ref: ../schemas/UserID.yaml

Check warning on line 198 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
security:
- authCookie: []
responses:
"200":
$ref: ../responses/permissions/PermissionResponse.yaml

Check warning on line 203 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.

Check warning on line 203 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"403":
Expand All @@ -213,8 +215,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/permissions/PermissionResponse.yaml

Check warning on line 219 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.

Check warning on line 219 in openapi/components/paths/miscellaneous.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"403":
Expand Down
4 changes: 2 additions & 2 deletions openapi/components/paths/worlds.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
paths:
/worlds:
get:
operationId: searchWorlds

Check notice on line 9 in openapi/components/paths/worlds.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listWorlds.
summary: Search All Worlds
description: Search and list any worlds by query filters.
tags:
Expand Down Expand Up @@ -50,7 +50,7 @@
tags:
- worlds
requestBody:
description: ""

Check warning on line 53 in openapi/components/paths/worlds.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
content:
application/json:
schema:
Expand All @@ -64,7 +64,7 @@
$ref: ../responses/MissingCredentialsError.yaml
/worlds/active:
get:
operationId: getActiveWorlds

Check notice on line 67 in openapi/components/paths/worlds.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listActiveWorlds.
summary: List Active Worlds
description: Search and list currently Active worlds by query filters.
tags:
Expand Down Expand Up @@ -92,7 +92,7 @@
$ref: ../responses/MissingCredentialsError.yaml
/worlds/favorites:
get:
operationId: getFavoritedWorlds

Check notice on line 95 in openapi/components/paths/worlds.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listFavoritedWorlds.
summary: List Favorited Worlds
description: Search and list favorited worlds by query filters.
tags:
Expand Down Expand Up @@ -122,7 +122,7 @@
$ref: ../responses/worlds/WorldSeeOtherUserFavoritesError.yaml
/worlds/recent:
get:
operationId: getRecentWorlds

Check notice on line 125 in openapi/components/paths/worlds.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listRecentWorlds.
summary: List Recent Worlds
description: Search and list recently visited worlds by query filters.
tags:
Expand Down Expand Up @@ -161,9 +161,10 @@
Works unauthenticated but when so will always return `0` for certain fields.
tags:
- worlds
security: []
responses:
"200":
$ref: ../responses/worlds/WorldResponse.yaml

Check notice on line 167 in openapi/components/paths/worlds.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: unknownplatform.

Check notice on line 167 in openapi/components/paths/worlds.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: standalonewindows.
"404":
$ref: ../responses/worlds/WorldNotFoundError.yaml
put:
Expand Down Expand Up @@ -211,8 +212,7 @@
description: Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with `updateWorld` and can be any arbitrary object.
tags:
- worlds
security:
- authCookie: []
security: []
responses:
"200":
$ref: ../responses/worlds/WorldMetadataResponse.yaml
Expand Down