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
11 changes: 11 additions & 0 deletions openapi/components/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,17 @@ avatarId:
required: true
schema:
type: string
messageType:
name: messageType
in: path
required: true
schema:
type: string
enum:
- message
- response
- request
- requestResponse
messageId:
name: messageId
in: path
Expand Down
8 changes: 4 additions & 4 deletions openapi/components/paths.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@
$ref: ./paths/permissions.yaml#/paths/~1permissions
'/permissions/{permissionId}':
$ref: './paths/permissions.yaml#/paths/~1permissions~1{permissionId}'
'/message/{userId}/message':
$ref: './paths/invite.yaml#/paths/~1message~1{userId}~1message'
'/message/{userId}/message/{messageId}':
$ref: './paths/invite.yaml#/paths/~1message~1{userId}~1message~1{messageId}'
'/message/{userId}/{messageType}':
$ref: './paths/invite.yaml#/paths/~1message~1{userId}~1{messageType}'
'/message/{userId}/{messageType}/{messageId}':
$ref: './paths/invite.yaml#/paths/~1message~1{userId}~1{messageType}~1{messageId}'
'/invite/{userId}':
$ref: './paths/invite.yaml#/paths/~1invite~1{userId}'
'/invite/{notificationId}/response':
Expand Down
40 changes: 36 additions & 4 deletions openapi/components/paths/invite.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ info:
version: '1.0'
description: Invite Docs Here
paths:
'/message/{userId}/message':
'/message/{userId}/{messageType}':
parameters:
- $ref: ../parameters.yaml#/userId
- $ref: ../parameters.yaml#/messageType
get:
summary: List Invite Messages
tags:
Expand All @@ -22,10 +23,19 @@ paths:
security:
- apiKeyCookie: []
authCookie: []
description: Returns a list of all that users Invite Messages. Admin Credentials are required to view messages of other users!
'/message/{userId}/message/{messageId}':
description: |-
Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users!

Message type refers to a different collection of messages, used during different types of responses.

* `message` = Message during a normal invite
* `response` = Message when replying to a message
* `request` = Message when requesting an invite
* `requestResponse` = Message when replying to a request for invite
'/message/{userId}/{messageType}/{messageId}':
parameters:
- $ref: ../parameters.yaml#/userId
- $ref: ../parameters.yaml#/messageType
- $ref: ../parameters.yaml#/messageId
get:
summary: Get Invite Messages
Expand All @@ -42,7 +52,15 @@ paths:
security:
- apiKeyCookie: []
authCookie: []
description: Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. Admin Credentials are required to view messages of other users!
description: |-
Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. Admin Credentials are required to view messages of other users!

Message type refers to a different collection of messages, used during different types of responses.

* `message` = Message during a normal invite
* `response` = Message when replying to a message
* `request` = Message when requesting an invite
* `requestResponse` = Message when replying to a request for invite
put:
summary: Update Invite Message
operationId: updateInviteMessage
Expand All @@ -53,6 +71,13 @@ paths:
Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users!

Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 Too Fast Error.

Message type refers to a different collection of messages, used during different types of responses.

* `message` = Message during a normal invite
* `response` = Message when replying to a message
* `request` = Message when requesting an invite
* `requestResponse` = Message when replying to a request for invite
responses:
'200':
$ref: ../responses/invite/InviteMessageListResponse.yaml
Expand Down Expand Up @@ -85,6 +110,13 @@ paths:
Resets a single Invite Message back to it's original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users!

Resetting a message respects the rate-limit, but resetting it does not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 Too Fast Error.

Message type refers to a different collection of messages, used during different types of responses.

* `message` = Message during a normal invite
* `response` = Message when replying to a message
* `request` = Message when requesting an invite
* `requestResponse` = Message when replying to a request for invite
'/invite/{userId}':
parameters:
- $ref: ../parameters.yaml#/userId
Expand Down