Skip to content

Commit

Permalink
Group Search API (vrchatapi#268)
Browse files Browse the repository at this point in the history
* Group Search API

* Fix Copy-Pasting issues
  • Loading branch information
Miner28 authored Jan 4, 2024
1 parent b461db3 commit 2613589
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 0 deletions.
20 changes: 20 additions & 0 deletions openapi/components/paths/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
description: Returns a list of LimitedGroup objects.
content:
application/json:
schema:
type: array
items:
$ref: ../../schemas/LimitedGroup.yaml
49 changes: 49 additions & 0 deletions openapi/components/schemas/LimitedGroup.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2613589

Please sign in to comment.