Skip to content

Commit

Permalink
docs: add documentation for wynncraft guildName api
Browse files Browse the repository at this point in the history
  • Loading branch information
AiverAiva committed Oct 19, 2023
1 parent da3051d commit 31784f8
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
2 changes: 2 additions & 0 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ paths:
# $ref: paths/wynncraft/challengeList.yaml
/wynncraft/guildPrefix:
$ref: paths/wynncraft/guildPrefix.yaml
/wynncraft/guildName:
$ref: paths/wynncraft/guildName.yaml
# /users/{username}:
# $ref: paths/users_{username}.yaml
# /pathItem:
Expand Down
35 changes: 35 additions & 0 deletions openapi/paths/wynncraft/guildName.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
get:
tags:
- Wynncraft
summary: Check the validity of a guild name or prefix
description: |
*very important* since the wynncraft api is case sensitive, please be cautious while using this.
operationId: guildName
parameters:
- in: path
name: guild
required: true
schema:
type: string
description: "*very important* if the guild name was delivered, please be cautious that it is case sensitive"
responses:
"200":
description: Successfully getting the guild name.
content:
application/json:
schema:
type: string
format: binary
examples:
Lmi:
value: "Luminosity"
"400":
description: Bad request, the prefix/name might not exist.
content:
application/json:
schema:
type: string
format: binary
examples:
Bad_request:
value: {"error": "Unknown guild name or prefix, this is case sensitive btw(check api.weikuwu.me for more infomation)"}

0 comments on commit 31784f8

Please sign in to comment.