Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions openapi/components/paths/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
$ref: ../responses/files/FileNotFoundError.yaml
/groups:
get:
operationId: searchGroups

Check notice on line 28 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroups.
summary: Search Group
description: Searches Groups by name or shortCode
tags:
Expand Down Expand Up @@ -96,8 +96,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupResponse.yaml

Check warning on line 100 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -111,13 +111,13 @@
requestBody:
content:
application/json:
schema:
$ref: ../requests/UpdateGroupRequest.yaml

Check warning on line 115 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupResponse.yaml

Check warning on line 120 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -129,11 +129,11 @@
tags:
- groups
parameters:
- name: hardDelete
required: false
in: query
schema:
type: boolean

Check warning on line 136 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

oas3-parameter-description

Parameter objects must have "description".
security:
- authCookie: []
responses:
Expand Down Expand Up @@ -204,7 +204,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupAuditLogEntryTypes

Check notice on line 207 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupAuditLogEntryTypes.
summary: Get Group Audit Log Entry Types
description: Returns a list of audit log entry types for which the group has entries.
tags:
Expand Down Expand Up @@ -238,8 +238,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupAuditLogListResponse.yaml

Check warning on line 242 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.

Check warning on line 242 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -248,7 +248,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupBans

Check notice on line 251 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupBans.
summary: Get Group Bans
description: Returns a list of banned users for a Group.
tags:
Expand Down Expand Up @@ -297,7 +297,7 @@
delete:
operationId: unbanGroupMember
summary: Unban Group Member
description: Unbans a user from a Group.

Check notice on line 300 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: Unbans, did you mean unban, unbars, or unmans?
tags:
- groups
security:
Expand Down Expand Up @@ -344,13 +344,13 @@
required: true
content:
application/json:
schema:
$ref: ../requests/CreateGroupGalleryRequest.yaml

Check warning on line 348 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupGalleryResponse.yaml

Check warning on line 353 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -360,7 +360,7 @@
- $ref: ../parameters.yaml#/groupId
- $ref: ../parameters.yaml#/groupGalleryId
get:
operationId: getGroupGalleryImages

Check notice on line 363 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupGalleryImages.
summary: Get Group Gallery Images
description: Returns a list of images for a Group gallery.
tags:
Expand Down Expand Up @@ -392,13 +392,13 @@
requestBody:
content:
application/json:
schema:
$ref: ../requests/UpdateGroupGalleryRequest.yaml

Check warning on line 396 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupGalleryResponse.yaml

Check warning on line 401 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand Down Expand Up @@ -489,7 +489,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupInstances

Check notice on line 492 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupInstances.
summary: Get Group Instances
description: Returns a list of group instances
tags:
Expand All @@ -497,8 +497,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupInstanceListResponse.yaml

Check notice on line 501 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: unknownplatform.

Check notice on line 501 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: standalonewindows.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -507,7 +507,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupInvites

Check notice on line 510 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupInvites.
summary: Get Group Invites Sent
description: Returns a list of members that have been invited to the Group.
tags:
Expand Down Expand Up @@ -648,7 +648,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupMembers

Check notice on line 651 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupMembers.
summary: List Group Members
description: |-
Returns a List of all **other** Group Members. This endpoint will never return the user calling the endpoint.
Expand Down Expand Up @@ -708,14 +708,14 @@
get:
operationId: getGroupMember
summary: Get Group Member
description: Returns a LimitedGroup Member.
description: Returns a GroupMember.
tags:
- groups
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupLimitedMemberResponse.yaml
$ref: ../responses/groups/GroupMemberResponse.yaml
"401":
$ref: ../responses/MissingCredentialsError.yaml
"403":
Expand All @@ -737,7 +737,7 @@
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupLimitedMemberResponse.yaml
$ref: ../responses/groups/GroupMemberResponse.yaml
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand Down

This file was deleted.

58 changes: 0 additions & 58 deletions openapi/components/schemas/GroupLimitedMember.yaml

This file was deleted.

25 changes: 21 additions & 4 deletions openapi/components/schemas/GroupMember.yaml
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
title: GroupMember
type: object
description: May be null when attempting to retrieve group membership for a user who is not part of the group
nullable: true
properties:
acceptedByDisplayName:
type: string
description: Only missing when explicitly fetching own user.
nullable: true
acceptedById:
type: string
description: Only missing when explicitly fetching own user.
nullable: true
bannedAt:
type: string
description: "Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user."
description: Only missing when explicitly fetching own user.
nullable: true
format: date-time
createdAt:
type: string
description: "Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user."
description: Only missing when explicitly fetching own user.
nullable: true
format: date-time
groupId:
$ref: ./GroupID.yaml
hasJoinedFromPurchase:
type: boolean
description: Missing when explicitly fetching own user, or when group isn't linked to a purchase.
id:
$ref: ./GroupMemberID.yaml
isRepresenting:
Expand All @@ -33,6 +38,7 @@ properties:
default: false
isSubscribedToEventAnnouncements:
type: boolean
description: Only missing when explicitly fetching own user.
joinedAt:
type: string
nullable: true
Expand All @@ -47,7 +53,7 @@ properties:
$ref: ./GroupRoleID.yaml
managerNotes:
type: string
description: "Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user."
description: Only missing when explicitly fetching own user.
nullable: true
membershipStatus:
$ref: ./GroupMemberStatus.yaml
Expand All @@ -57,9 +63,20 @@ properties:
$ref: ./GroupRoleID.yaml
user:
$ref: ./GroupMemberLimitedUser.yaml
nullable: true
userId:
$ref: ./UserID.yaml
visibility:
type: string
example: visible
required:
- groupId
- id
- isRepresenting
- isSubscribedToAnnouncements
- joinedAt
- lastPostReadAt
- mRoleIds
- membershipStatus
- roleIds
- userId
- visibility
1 change: 1 addition & 0 deletions openapi/components/schemas/GroupMemberLimitedUser.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
title: GroupMemberLimitedUser
type: object
description: "Only visible via the /groups/:groupId/members endpoint, **not** when fetching a specific user."
nullable: true
properties:
currentAvatarTags:
type: array
Expand Down
13 changes: 0 additions & 13 deletions openapi/components/schemas/LimitedGroupMember.yaml

This file was deleted.