aboutsummaryrefslogtreecommitdiff
path: root/swagger.json
diff options
context:
space:
mode:
authorawesomepandapig <34806109+awesomepandapig@users.noreply.github.com>2022-07-30 03:03:29 -0700
committerGitHub <noreply@github.com>2022-07-30 03:03:29 -0700
commit680d4962a0d24a2f744027046810c14706f3de07 (patch)
treea77da69d1497d75d9750e4a0702ca998cc4d483e /swagger.json
parent603f1c434a8bce8afefd01653334559ea48c1d63 (diff)
downloadskyblock.bingo-680d4962a0d24a2f744027046810c14706f3de07.tar.gz
skyblock.bingo-680d4962a0d24a2f744027046810c14706f3de07.tar.bz2
skyblock.bingo-680d4962a0d24a2f744027046810c14706f3de07.zip
Add files via upload
Diffstat (limited to 'swagger.json')
-rw-r--r--swagger.json73
1 files changed, 73 insertions, 0 deletions
diff --git a/swagger.json b/swagger.json
new file mode 100644
index 0000000..fb8fc08
--- /dev/null
+++ b/swagger.json
@@ -0,0 +1,73 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "description": "This API provides Hypixel Skyblock bingo data.",
+ "version": "1.0.0",
+ "title": "Bingo API",
+ "license": {
+ "name": "MIT",
+ "url": "https://opensource.org/licenses/MIT"
+ }
+ },
+ "host": "skyblock.bingo/api",
+ "tags": [
+ {
+ "name": "stats",
+ "description": "Gets a player's bingo stats"
+ },
+ {
+ "name": "leaderboard",
+ "description": "Get the top 100 bingo players"
+ }
+ ],
+ "schemes": [
+ "https",
+ "http"
+ ],
+ "paths": {
+ "/stats/{username/uuid}": {
+ "get": {
+ "tags": [
+ "stats"
+ ],
+ "operationId": "getStats",
+ "produces": [
+ "application/xml",
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "username/uuid",
+ "in": "path",
+ "description": "Username or UUID",
+ "required": true,
+ "type": "string",
+ "format": "utf8"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful operation"
+ }
+ }
+ }
+ },
+ "/leaderboard": {
+ "get": {
+ "tags": [
+ "leaderboard"
+ ],
+ "operationId": "getLeaderboard",
+ "produces": [
+ "application/xml",
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful operation"
+ }
+ }
+ }
+ }
+ }
+} \ No newline at end of file