113 lines
2.4 KiB
YAML
113 lines
2.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:
|
|
/message/send:
|
|
post:
|
|
summary: "POST message/send"
|
|
operationId: "postMessage"
|
|
tags:
|
|
- Message
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/MessagePostRequestDto"
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: "OK"
|
|
content:
|
|
'*/*':
|
|
schema:
|
|
$ref: "#/components/schemas/ResponseBodyString"
|
|
|
|
/message/history/{clientId}:
|
|
get:
|
|
summary: "GET message/history/{clientId}"
|
|
operationId: "history"
|
|
tags:
|
|
- Message
|
|
parameters:
|
|
- name: "clientId"
|
|
in: "path"
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
- name: "$top"
|
|
in: "query"
|
|
required: false
|
|
schema:
|
|
type: "integer"
|
|
format: "int32"
|
|
default: "20"
|
|
responses:
|
|
"200":
|
|
description: "OK"
|
|
content:
|
|
'*/*':
|
|
schema:
|
|
$ref: "#/components/schemas/ResponseBodyString"
|
|
|
|
components:
|
|
schemas:
|
|
ResponseBodyString:
|
|
type: "object"
|
|
properties:
|
|
data:
|
|
type: "string"
|
|
nullable: true
|
|
message:
|
|
type: "string"
|
|
nullable: true
|
|
success:
|
|
type: "boolean"
|
|
nullable: false
|
|
|
|
MessagePostRequestDto:
|
|
type: "object"
|
|
properties:
|
|
content:
|
|
type: "string"
|
|
nullable: true
|
|
clientId:
|
|
type: "string"
|
|
nullable: true
|
|
timeStamp:
|
|
type: "integer"
|
|
format: "int32"
|
|
nullable: true
|
|
|
|
ResponseBodyListMessageDto:
|
|
type: "object"
|
|
properties:
|
|
data:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/MessageDto"
|
|
nullable: true
|
|
message:
|
|
type: "string"
|
|
nullable: true
|
|
success:
|
|
type: "boolean"
|
|
nullable: false
|
|
|
|
MessageDto:
|
|
type: "object"
|
|
properties:
|
|
content:
|
|
type: "string"
|
|
nullable: true
|
|
timestamp:
|
|
type: "integer"
|
|
format: "int64"
|
|
nullable: true
|
|
Void:
|
|
type: "object"
|
|
properties: { } |