Added support for group posts controls (#315)

* Added support for group post controls * Changed nullable field properties on non-nullables --------- Co-authored-by: Veerce <[email protected]>
vrchatapi · Apr 23, 2024 · bec9a23 · bec9a23
1 parent 08322f7
commit bec9a23
Show file tree

Hide file tree

Showing 7 changed files with 149 additions and 0 deletions.
diff --git a/openapi/components/paths.yaml b/openapi/components/paths.yaml
@@ -134,6 +134,10 @@
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1members~1{userId}~1roles~1{groupRoleId}"
 "/groups/{groupId}/permissions":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1permissions"
+"/groups/{groupId}/posts":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1posts"
+"/groups/{groupId}/posts/{notificationId}":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1posts~1{notificationId}"
 "/groups/{groupId}/requests":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1requests"
 "/groups/{groupId}/requests/{userId}":

diff --git a/openapi/components/paths/groups.yaml b/openapi/components/paths/groups.yaml
@@ -643,6 +643,68 @@ paths:
           $ref: ../responses/groups/GroupNotFoundError.yaml
       security:
         - authCookie: []
+  '/groups/{groupId}/posts':
+    parameters:
+      - $ref: ../parameters.yaml#/groupId
+    get:
+      summary: Get posts from a Group
+      description: Get posts from a Group
+      operationId: getGroupPost
+      tags:
+        - groups
+      parameters:
+        - $ref: ../parameters.yaml#/number
+        - $ref: ../parameters.yaml#/offset
+        - schema:
+            type: boolean
+          in: query
+          name: publicOnly
+          description: See public posts only.
+      responses:
+        '200':
+          $ref: ../responses/groups/GroupPostResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      security:
+        - authCookie: []
+    post:
+      summary: Create a post in a Group
+      description: Create a post in a Group.
+      operationId: addGroupPost
+      tags:
+        - groups
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: ../requests/CreateGroupPostRequest.yaml
+      responses:
+        '200':
+          $ref: ../responses/groups/GroupPostResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      security:
+        - authCookie: []
+  '/groups/{groupId}/posts/{notificationId}':
+    parameters:
+      - $ref: ../parameters.yaml#/groupId
+      - $ref: ../parameters.yaml#/notificationId
+    delete:
+      summary: Delete a Group post
+      description: Delete a Group post
+      operationId: deleteGroupPost
+      tags:
+        - groups
+      responses:
+        '200':
+          $ref: ../responses/groups/DeleteGroupPostResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+        '404':
+          $ref: ../responses/groups/DeleteGroupPostResponse.yaml
+      security:
+        - authCookie: []
   '/groups/{groupId}/requests':
     parameters:
       - $ref: ../parameters.yaml#/groupId

diff --git a/openapi/components/requests/CreateGroupPostRequest.yaml b/openapi/components/requests/CreateGroupPostRequest.yaml
@@ -0,0 +1,29 @@
+title: CreateGroupPostRequest
+type: object
+properties:
+  title:
+    type: string
+    description: Post title
+    minLength: 1
+    example: "Event is starting soon!"
+  text:
+    type: string
+    description: Post text
+    minLength: 1
+    example: "Come join us for the event!"
+  imageId:
+    $ref: ../schemas/FileID.yaml
+  sendNotification:
+    type: boolean
+    description: Send notification to group members.
+    default: false
+    example: false
+  roleIds:
+    $ref: ../schemas/GroupRoleIDList.yaml
+  visibility:
+    $ref: ../schemas/GroupPostVisibility.yaml
+required:
+  - title
+  - text
+  - sendNotification
+  - visibility
diff --git a/openapi/components/responses/groups/DeleteGroupPostResponse.yaml b/openapi/components/responses/groups/DeleteGroupPostResponse.yaml
@@ -0,0 +1,11 @@
+description: Response after deleting a group post.
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/Success.yaml
+    examples:
+      Deleted Group Post:
+        value:
+          success:
+            message: Group Post was deleted!
+            status_code: 200
diff --git a/openapi/components/responses/groups/GroupPostResponse.yaml b/openapi/components/responses/groups/GroupPostResponse.yaml
@@ -0,0 +1,5 @@
+description: Returns a GroupPost object.
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/GroupPost.yaml
diff --git a/openapi/components/schemas/GroupPost.yaml b/openapi/components/schemas/GroupPost.yaml
@@ -0,0 +1,32 @@
+title: GroupPost
+type: object
+properties:
+  id:
+    $ref: ./NotificationID.yaml
+  groupId:
+    $ref: ./GroupID.yaml
+  authorId:
+    $ref: ./UserID.yaml
+  editorId:
+    $ref: ./UserID.yaml
+    nullable: true
+  visibility:
+    $ref: ./GroupPostVisibility.yaml
+  roleId:
+    $ref: ./GroupRoleIDList.yaml
+  title:
+    type: string
+  text:
+    type: string
+  imageId:
+    $ref: ./FileID.yaml
+    nullable: true
+  imageUrl:
+    type: string
+    nullable: true
+  createdAt:
+    type: string
+    format: date-time
+  updatedAt:
+    type: string
+    format: date-time
diff --git a/openapi/components/schemas/GroupPostVisibility.yaml b/openapi/components/schemas/GroupPostVisibility.yaml
@@ -0,0 +1,6 @@
+example: public
+title: GroupPostVisibility
+type: string
+enum:
+  - group
+  - public