From 8d6da61c5c9916cf7c747a2a0cb141b1a8a0097e Mon Sep 17 00:00:00 2001 From: AiverAiva <43096905+AiverAiva@users.noreply.github.com> Date: Fri, 13 Oct 2023 07:01:35 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20AiverAiv?= =?UTF-8?q?a/documents@681fce74005e8dba566d2d91c57116124295665e=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- bundle.json | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 74 insertions(+), 2 deletions(-) diff --git a/bundle.json b/bundle.json index 01ce610..ade8784 100644 --- a/bundle.json +++ b/bundle.json @@ -18,11 +18,83 @@ "description": "Basic checks to the api." }, { - "name": "osu", - "description": "osu! related endpoints." + "name": "osu!", + "description": "osu! related." } ], "paths": { + "/osu/profileCard/{username}": { + "get": { + "tags": [ + "osu!" + ], + "summary": "Get player profile card image", + "description": "This endpoint returns an image of the player's profile data for the specified username. \nThe profile card contains visual representation of player data such as avatar, rank, and statistics.\n", + "operationId": "profileCard", + "parameters": [ + { + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + }, + "description": "The username of the player for whom the profile card image is requested." + }, + { + "in": "query", + "name": "mode", + "required": false, + "schema": { + "type": "string", + "enum": [ + "osu", + "taiko", + "fruits", + "mania" + ] + }, + "description": "**Optional** mode parameter with possible values \"osu\", \"taiko\", \"fruits\"or \"mania\"." + } + ], + "responses": { + "200": { + "description": "Successful response with player profile card image.", + "content": { + "image/png": { + "schema": { + "type": "string", + "format": "binary" + }, + "examples": { + "response": { + "value": "an image" + } + } + } + } + }, + "400": { + "description": "Player not found. Indicates that the specified username does not exist.", + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "binary" + }, + "examples": { + "response": { + "value": { + "error": "Unknown username or mode, please check the documents. (api.weikuwu.me)" + } + } + } + } + } + } + } + } + }, "/hello": { "post": { "tags": [