Basic Groups API (#197)

* wip: group api

* Typo Fixes

* CreateGroupRequest, Typo Fixes

* GetUserList

* Add new endpoints to path.yaml

* Update lint, fixes

* Create GroupID.yaml

* Create GroupID, GroupMemberID, GroupRoleID

* Create GroupGalleryID.yaml

* Delete GroupMemberID.yaml

* Revert "Delete GroupMemberID.yaml"

This reverts commit 0c1592d.

* .

* GroupMember

* GroupGallery

* .

* Update GroupMyMember.yaml

* Remove mention of guilds

* GroupNotFoundError description

* Make GroupShortCode regex compliant

* .

* Update lint

* gitignore update

* operationId on paths./groups.post

* Sort tags

* Groups

* CreateGroupRoleRequest

* Group Join, Leave

* User Requests, Path

* List Group Requests

* Fix Group Requests

* Group Invites, Requests

* Add Description, fixes

* Typos, Fixes

* Minor update to route descriptions

* Clear lint errors

* Add security headers and sort

* Fix duplicate array descriptions (rendering bug)

* Minor title fix in users.yaml

* Add List  Group Members

Co-authored-by: Aries Clark <[email protected]>
Co-authored-by: Foorack / Max Faxälv <[email protected]>

.gitignore

@@ -1,2 +1,3 @@
 **/node_modules
-dist
+dist
+.idea

openapi/components/parameters.yaml

@@ -86,6 +86,24 @@ fileId:
     type: string
     example: file_00000000-0000-0000-0000-000000000000
     pattern: 'file_[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}'
+  description: Must be a valid file ID.
+groupId:
+  name: groupId
+  in: path
+  required: true
+  schema:
+    type: string
+    example: grp_00000000-0000-0000-0000-000000000000
+    pattern: 'grp_[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}'
+  description: Must be a valid group ID.
+groupRoleId:
+  name: groupRoleId
+  in: path
+  required: true
+  schema:
+    type: string
+    example: grol_00000000-0000-0000-0000-000000000000
+    pattern: 'grol_[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}'
 versionId:
   name: versionId
   in: path
@@ -94,6 +112,7 @@ versionId:
     type: integer
     minimum: 1
     example: 1
+  description: Version ID of the asset.
 fileType:
   name: fileType
   in: path
@@ -105,12 +124,14 @@ fileType:
       - signature
       - delta
     example: file
+  description: Type of file.
 userId:
   name: userId
   in: path
   required: true
   schema:
     type: string
+  description: Must be a valid user ID.
 userIdQuery:
   name: userId
   in: query
@@ -215,6 +236,7 @@ worldId:
   required: true
   schema:
     type: string
+  description: Must be a valid world ID.
 instanceId:
   name: instanceId
   in: path

openapi/components/paths.yaml

@@ -92,6 +92,29 @@
 "/auth/user/friends/{userId}":
   $ref: "./paths/friends.yaml#/paths/~1auth~1user~1friends~1{userId}"
 
+# groups
+
+"/groups":
+  $ref: "./paths/groups.yaml#/paths/~1groups"
+"/groups/{groupId}":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}"
+"/groups/{groupId}/roles":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1roles"
+"/groups/{groupId}/members":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1members"
+"/groups/{groupId}/roles/{groupRoleId}":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1roles~1{groupRoleId}"
+"/groups/{groupId}/join":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1join"
+"/groups/{groupId}/leave":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1leave"
+"/groups/{groupId}/requests":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1requests"
+"/groups/{groupId}/invites":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1invites"
+"/groups/{groupId}/invites/{userId}":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1invites~1{userId}"
+
 # invite
 
 "/invite/{userId}":
@@ -176,6 +199,10 @@
   $ref: "./paths/users.yaml#/paths/~1users~1{username}~1name"
 "/users/{userId}":
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}"
+"/users/{userId}/groups":
+  $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups"
+"/users/{userId}/groups/requested":
+  $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1requested"
 
 # worlds
 
@@ -195,3 +222,4 @@
   $ref: "./paths/worlds.yaml#/paths/~1worlds~1{worldId}~1publish"
 "/worlds/{worldId}/{instanceId}":
   $ref: "./paths/worlds.yaml#/paths/~1worlds~1{worldId}~1{instanceId}"
+

openapi/components/paths/files.yaml

@@ -193,6 +193,8 @@ paths:
           in: query
           name: partNumber
           required: false
+          description: The part number to start uploading. If not provided, the first part will be started.
+          deprecated: true
       security:
         - apiKeyCookie: []
           authCookie: []