feature(permissions): Add basic Permission endpoints

.spectral.yaml

@@ -3,8 +3,11 @@ formats:
 extends:
   - 'spectral:oas'
 rules:
-  contact-properties: warn
-  info-license: warn
-  license-url: warn
   oas3-parameter-description: info
   tag-description: hint
+
+  # Rules for sub schema
+  info-license: hint
+  license-url: hint
+  oas3-api-servers: hint
+  info-contact: hint

openapi/components/paths/permissions.yaml

@@ -0,0 +1,121 @@
+openapi: 3.0.3
+info:
+  title: permissions
+  version: '1.0'
+  description: 'Permissions are a way to individually grant specific access to a user, often through a license such as VRC+ subscription.'
+paths:
+  /auth/permissions:
+    get:
+      summary: Get Assigned Permission
+      operationId: getAssignedPermissions
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: '#/components/responses/PermissionListResponse'
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - permissions
+      description: Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
+    parameters: []
+  /permissions:
+    get:
+      summary: Get Permissions
+      tags: []
+      responses:
+        '200':
+          $ref: '#/components/responses/PermissionListResponse'
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      operationId: getPermissions
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      x-internal: true
+      description: '**REQUIRES INTERNAL ADMIN CREDENTIALS**. Returns a list of all existing permissions, just like `/users` with empty search would.'
+  '/permissions/{permissionId}':
+    parameters:
+      - $ref: '#/components/parameters/permissionId'
+    get:
+      summary: Get Permission
+      tags:
+        - permissions
+      responses:
+        '200':
+          $ref: '#/components/responses/PermissionResponse'
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      operationId: getPermission
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      description: 'Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.'
+tags:
+  $ref: ../../openapi.yaml#/tags
+components:
+  responses:
+    PermissionListResponse:
+      description: Returns a list of Permission objects.
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: ../schemas/Permission.yaml
+          examples:
+            Standard Permissions Inherited By VRC+:
+              value:
+                - id: prms_fe07c8a7-a4ca-4eda-97e5-e241040ef6f8
+                  ownerId: usr_17f19d1e-fd48-493b-a8ad-807a3d8bdd1b
+                  name: permission-trust-boost
+                - id: prms_804ba021-9f47-4e25-9847-1f42fdb2e6ff
+                  ownerId: usr_17f19d1e-fd48-493b-a8ad-807a3d8bdd1b
+                  name: permission-extra-favorites-avatar-groups
+                  data:
+                    maxFavoritesPerGroup:
+                      avatar: 25
+                    maxFavoriteGroups:
+                      avatar: 4
+                - id: prms_ac88a3e0-c236-47c7-9b47-d795551b7520
+                  ownerId: usr_17f19d1e-fd48-493b-a8ad-807a3d8bdd1b
+                  name: permission-early-adopter-tags
+                  data:
+                    tags:
+                      - system_early_adopter
+                - id: prms_76f33deb-dd5d-46b7-b79d-e1f8f0a9a1e0
+                  ownerId: usr_17f19d1e-fd48-493b-a8ad-807a3d8bdd1b
+                  name: permission-supporter-tags
+                  data:
+                    tags:
+                      - system_supporter
+                - id: prms_0d9549db-d30a-48f3-a6b8-6741ce5a4283
+                  ownerId: usr_bc012e97-a292-4abc-b4e6-f9edcc8c0d2b
+                  name: permission-invite-photos
+                  data: {}
+                - id: prms_153ac0b7-c2dd-43f9-96e3-c61fd2e85509
+                  ownerId: usr_bc012e97-a292-4abc-b4e6-f9edcc8c0d2b
+                  name: permission-profile-pic-override
+                  data: {}
+                - id: prms_1d9549db-d30a-48f3-a6b8-6741ce5a4283
+                  ownerId: usr_bc012e97-a292-4abc-b4e6-f9edcc8c0d2b
+                  name: permission-user-icons
+                  data: {}
+                - id: prms_dc02c512-4c03-479c-8c6a-d9329c023baf
+                  ownerId: usr_bc012e97-a292-4abc-b4e6-f9edcc8c0d2b
+                  name: permission-user-gallery
+                  data: {}
+    PermissionResponse:
+      description: Returns a single Permission object.
+      content:
+        application/json:
+          schema:
+            $ref: ../schemas/Permission.yaml
+  parameters:
+    permissionId:
+      name: permissionId
+      in: path
+      required: true
+      schema:
+        type: string

openapi/components/schemas/Permission.yaml

@@ -0,0 +1,27 @@
+description: ''
+type: object
+properties:
+  id:
+    $ref: ./PermissionID.yaml
+  ownerId:
+    $ref: ./UserID.yaml
+  name:
+    type: string
+    minLength: 1
+    example: permission-invite-photos
+  data:
+    type: object
+required:
+  - id
+  - ownerId
+  - name
+title: Permission
+example:
+  id: prms_804ba021-9f47-4e25-9847-1f42fdb2e6ff
+  ownerId: usr_17f19d1e-fd48-493b-a8ad-807a3d8bdd1b
+  name: permission-extra-favorites-avatar-groups
+  data:
+    maxFavoritesPerGroup:
+      avatar: 25
+    maxFavoriteGroups:
+      avatar: 4

openapi/components/schemas/PermissionID.yaml

@@ -0,0 +1,4 @@
+type: string
+title: PermissionID
+pattern: 'prms_[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}'
+example: prms_804ba021-9f47-4e25-9847-1f42fdb2e6ff

openapi/openapi.yaml

@@ -1,4 +1,4 @@
-openapi: 3.0.0
+openapi: 3.0.3
 info:
   title: VRChat API Documentation
   version: 1.0.2
@@ -1933,7 +1933,7 @@ paths:
         '200':
           $ref: ./components/responses/PlayerModerationRemovedSuccess.yaml
         '401':
-          $ref: '#/components/responses/MissingCredentials'
+          $ref: ./components/responses/MissingCredentialsError.yaml
         '403':
           $ref: ./components/responses/PlayerModerationDeleteOthersError.yaml
       description: Deletes a specific player moderation based on it's `pmod_` ID. The website uses `unmoderateUser` instead. You can delete the same player moderation multiple times successfully.
@@ -1945,6 +1945,12 @@ paths:
         name: playerModerationId
         in: path
         required: true
+  /auth/permissions:
+      $ref: ./components/paths/permissions.yaml#/paths/~1auth~1permissions
+  /permissions:
+      $ref: ./components/paths/permissions.yaml#/paths/~1permissions
+  '/permissions/{permissionId}':
+      $ref: ./components/paths/permissions.yaml#/paths/~1permissions~1{permissionId}
 components:
   schemas: {}
   securitySchemes:
@@ -2663,6 +2669,7 @@ tags:
   - name: files
   - name: friends
   - name: notifications
+  - name: permissions
   - name: playermoderation
   - name: system
   - name: users