124 lines
2.6 KiB
YAML
124 lines
2.6 KiB
YAML
openapi: "3.1.0"
|
|
info:
|
|
title: "boardmate_api API"
|
|
description: "boardmate_api API"
|
|
version: "1.0.0"
|
|
servers:
|
|
- url: "https://boardmate_api"
|
|
paths:
|
|
/games/{id}:
|
|
get:
|
|
summary: "GET games/{id}"
|
|
operationId: "retrieveGames"
|
|
tags:
|
|
- Game
|
|
parameters:
|
|
- name: "id"
|
|
in: "path"
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "OK"
|
|
content:
|
|
'*/*':
|
|
schema:
|
|
$ref: "#/components/schemas/ResponseBodyGameDto"
|
|
/create:
|
|
post:
|
|
summary: "POST create"
|
|
operationId: "CreateParty"
|
|
tags:
|
|
- Game
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/GameDto"
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: "OK"
|
|
content:
|
|
'*/*':
|
|
schema:
|
|
$ref: "#/components/schemas/ResponseBodyString"
|
|
/moves/add/{gameId}:
|
|
post:
|
|
summary: "POST moves/add/{gameId}"
|
|
operationId: "AddMove"
|
|
tags:
|
|
- Game
|
|
parameters:
|
|
- name: "gameId"
|
|
in: "path"
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/MoveDto"
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: "OK"
|
|
content:
|
|
'*/*':
|
|
schema:
|
|
$ref: "#/components/schemas/ResponseBodyString"
|
|
components:
|
|
schemas:
|
|
|
|
ResponseBodyGameDto:
|
|
type: "object"
|
|
properties:
|
|
data:
|
|
type: "object"
|
|
nullable: true
|
|
message:
|
|
type: "string"
|
|
nullable: true
|
|
success:
|
|
type: "boolean"
|
|
nullable: false
|
|
|
|
ResponseBodyString:
|
|
type: "object"
|
|
properties:
|
|
data:
|
|
type: "string"
|
|
nullable: true
|
|
message:
|
|
type: "string"
|
|
nullable: true
|
|
success:
|
|
type: "boolean"
|
|
nullable: false
|
|
|
|
GameDto:
|
|
type: "object"
|
|
properties:
|
|
whiteName:
|
|
type: "string"
|
|
nullable: true
|
|
blackName:
|
|
type: "string"
|
|
nullable: true
|
|
timeValue:
|
|
type: "integer"
|
|
format: "int32"
|
|
nullable: true
|
|
increment:
|
|
type: "integer"
|
|
format: "int32"
|
|
nullable: true
|
|
|
|
MoveDto:
|
|
type: "object"
|
|
properties:
|
|
notation:
|
|
type: "string"
|
|
nullable: false |