-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(group): document more error responses (#303)
Document some more error responses for group endpoints.
- Loading branch information
Showing
4 changed files
with
43 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
openapi/components/responses/groups/GroupInviteBadRequestError.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
description: Bad request error response when creating a group invite. | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../schemas/Error.yaml | ||
examples: | ||
Group Member Already Exists: | ||
value: | ||
error: | ||
message: User <displayName> is already a member of this group. | ||
status_code: 400 | ||
User Already Invited: | ||
value: | ||
error: | ||
message: User <displayName> is already invited. | ||
status_code: 400 |
11 changes: 11 additions & 0 deletions
11
openapi/components/responses/groups/GroupInviteForbiddenError.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
description: Forbidden error response when creating a group invite. | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../schemas/Error.yaml | ||
examples: | ||
Forbidden to Invite User: | ||
value: | ||
error: | ||
message: You can't invite that user․ | ||
status_code: 403 |
11 changes: 11 additions & 0 deletions
11
openapi/components/responses/groups/GroupJoinRequestResponseBadRequestError.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
description: Bad request error response when responding to a group join request | ||
content: | ||
application/json: | ||
schema: | ||
$ref: ../../schemas/Error.yaml | ||
examples: | ||
User Join Request Not Exist: | ||
value: | ||
error: | ||
message: You can't accept a join request for a user who hasn't requested to join․ | ||
status_code: 400 |