68 lines
1.4 KiB
YAML
68 lines
1.4 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:
|
|
/authenticate:
|
|
post:
|
|
summary: "POST authenticate"
|
|
operationId: "login"
|
|
tags:
|
|
- Auth
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/AuthRequestDto"
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: "OK"
|
|
content:
|
|
'*/*':
|
|
schema:
|
|
$ref: "#/components/schemas/ResponseBodyAuthResponseDto"
|
|
|
|
components:
|
|
schemas:
|
|
AuthRequestDto:
|
|
type: "object"
|
|
properties:
|
|
username:
|
|
type: "string"
|
|
nullable: true
|
|
key:
|
|
type: "string"
|
|
nullable: true
|
|
|
|
ResponseBodyAuthResponseDto:
|
|
type: "object"
|
|
properties:
|
|
data:
|
|
type: "object"
|
|
nullable: true
|
|
message:
|
|
type: "string"
|
|
nullable: true
|
|
success:
|
|
type: "boolean"
|
|
nullable: false
|
|
|
|
AuthResponseDto:
|
|
type: "object"
|
|
properties:
|
|
clientId:
|
|
type: "string"
|
|
nullable: true
|
|
name:
|
|
type: "string"
|
|
nullable: true
|
|
username:
|
|
type: "string"
|
|
nullable: true
|
|
authToken:
|
|
type: "string"
|
|
nullable: true |