diff --git a/docs/docs.go b/docs/docs.go index e7aecb5..645829d 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -415,14 +415,14 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Get a specific time by its ID", + "description": "Get a download url for the bot replay of a time by its ID if it exists", "produces": [ "application/json" ], "tags": [ "times" ], - "summary": "Get time by ID", + "summary": "Get bot download url by time ID", "parameters": [ { "type": "integer", @@ -436,11 +436,11 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Response-Time" + "$ref": "#/definitions/Response-BotDownloadUrl" } }, "404": { - "description": "Time not found", + "description": "Bot not found", "schema": { "$ref": "#/definitions/Error" } @@ -621,6 +621,14 @@ const docTemplate = `{ } }, "definitions": { + "BotDownloadUrl": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + } + }, "Error": { "type": "object", "properties": { @@ -809,6 +817,19 @@ const docTemplate = `{ } } }, + "Response-BotDownloadUrl": { + "type": "object", + "properties": { + "data": { + "description": "Data contains the actual response payload", + "allOf": [ + { + "$ref": "#/definitions/BotDownloadUrl" + } + ] + } + } + }, "Response-Map": { "type": "object", "properties": { diff --git a/docs/swagger.json b/docs/swagger.json index 372f700..926981a 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -408,14 +408,14 @@ "ApiKeyAuth": [] } ], - "description": "Get a specific time by its ID", + "description": "Get a download url for the bot replay of a time by its ID if it exists", "produces": [ "application/json" ], "tags": [ "times" ], - "summary": "Get time by ID", + "summary": "Get bot download url by time ID", "parameters": [ { "type": "integer", @@ -429,11 +429,11 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Response-Time" + "$ref": "#/definitions/Response-BotDownloadUrl" } }, "404": { - "description": "Time not found", + "description": "Bot not found", "schema": { "$ref": "#/definitions/Error" } @@ -614,6 +614,14 @@ } }, "definitions": { + "BotDownloadUrl": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + } + }, "Error": { "type": "object", "properties": { @@ -802,6 +810,19 @@ } } }, + "Response-BotDownloadUrl": { + "type": "object", + "properties": { + "data": { + "description": "Data contains the actual response payload", + "allOf": [ + { + "$ref": "#/definitions/BotDownloadUrl" + } + ] + } + } + }, "Response-Map": { "type": "object", "properties": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 6a8bb2b..335f4cb 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -1,5 +1,10 @@ basePath: /api/v1 definitions: + BotDownloadUrl: + properties: + url: + type: string + type: object Error: properties: error: @@ -119,6 +124,13 @@ definitions: user: $ref: '#/definitions/User' type: object + Response-BotDownloadUrl: + properties: + data: + allOf: + - $ref: '#/definitions/BotDownloadUrl' + description: Data contains the actual response payload + type: object Response-Map: properties: data: @@ -379,7 +391,8 @@ paths: - times /time/{id}: get: - description: Get a specific time by its ID + description: Get a download url for the bot replay of a time by its ID if it + exists parameters: - description: Time ID in: path @@ -392,9 +405,9 @@ paths: "200": description: OK schema: - $ref: '#/definitions/Response-Time' + $ref: '#/definitions/Response-BotDownloadUrl' "404": - description: Time not found + description: Bot not found schema: $ref: '#/definitions/Error' default: @@ -403,7 +416,7 @@ paths: $ref: '#/definitions/Error' security: - ApiKeyAuth: [] - summary: Get time by ID + summary: Get bot download url by time ID tags: - times /time/placement: