Group Search API

openapi/components/paths/groups.yaml

@@ -5,6 +5,26 @@ info:
   description: Group Docs Here
 paths:
   /groups:
+    get:
+      summary: Search Group
+      description: Searches Groups by name or shortCode
+      operationId: searchGroups
+      tags:
+        - groups
+      parameters:
+        - in: query
+          name: query
+          schema:
+            type: string
+          required: false
+          description: Query to search for, can be either Group Name or Group shortCode
+        - $ref: ../parameters.yaml#/offset
+        - $ref: ../parameters.yaml#/number
+      responses:
+        '200':
+          $ref: ../responses/groups/LimitedGroupListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
     post:
       summary: Create Group
       description: Creates a Group and returns a Group object. **Requires VRC+ Subscription.**

openapi/components/responses/groups/LimitedGroupListResponse.yaml

@@ -0,0 +1,7 @@
+description: Returns a list of LimitedGroup objects.
+content:
+  application/json:
+    schema:
+      type: array
+      items:
+        $ref: ../../schemas/LimitedGroup.yaml

openapi/components/schemas/LimitedGroup.yaml

@@ -0,0 +1,49 @@
+title: LimitedGroup
+type: object
+properties:
+  id:
+    $ref: ./GroupID.yaml
+  name:
+    type: string
+  shortCode:
+    $ref: ./GroupShortCode.yaml
+  discriminator:
+    $ref: ./GroupDiscriminator.yaml
+  description:
+    type: string
+  iconUrl:
+    type: string
+    nullable: true
+  bannerUrl:
+    type: string
+    nullable: true
+  ownerId:
+    $ref: ./UserID.yaml
+  rules:
+    type: string
+    nullable: true
+  iconId:
+    type: string
+    nullable: true
+  bannerId:
+    type: string
+    nullable: true
+  memberCount:
+    type: integer
+  tags:
+    description: ' '
+    type: array
+    items:
+      $ref: ./Tag.yaml
+  createdAt:
+    type: string
+    format: date-time
+  membershipStatus:
+    $ref: ./GroupMemberStatus.yaml
+  isSearchable:
+    type: boolean
+  galleries:
+    description: ' '
+    type: array
+    items:
+      $ref: ./GroupGallery.yaml