Files
AltitudeWeb/open_api/src/main/resources/schemas/server-message/server-message.yml
T

193 lines
4.5 KiB
YAML

sendServerMessage:
post:
tags:
- server-message
summary: Send a message to a specific server
operationId: sendServerMessage
parameters:
- $ref: '#/components/parameters/Server'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServerMessageRequest'
responses:
'202':
description: Message accepted and sent
'404':
description: Server not found or not connected
'400':
description: Invalid request
sendAdminChat:
post:
tags:
- server-message
summary: Send an admin chat to a specific server
operationId: sendAdminChat
parameters:
- $ref: '#/components/parameters/Server'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServerMessageRequest'
responses:
'202':
description: Message accepted and sent
'404':
description: Server not found or not connected
'400':
description: Invalid request
sendPrivateMessage:
post:
tags:
- server-message
summary: Send a private message
operationId: sendPrivateMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateMessageRequest'
responses:
'202':
description: Message accepted and sent
'400':
description: Invalid request
sendPartyMessage:
post:
tags:
- server-message
summary: Send a party message
operationId: sendPartyMessage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PartyMessageRequest'
responses:
'202':
description: Message accepted and sent
'400':
description: Invalid request
punishPlayer:
post:
tags:
- server-message
summary: Punish a player on a specific server
operationId: punishPlayer
parameters:
- $ref: '#/components/parameters/Server'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PunishRequest'
responses:
'202':
description: Punishment accepted and applied
'404':
description: Server not found or not connected
'400':
description: Invalid request
components:
parameters:
Server:
name: server
in: path
required: true
schema:
type: string
description: The name of the server
schemas:
ServerMessageRequest:
type: object
required:
- uuid
- message
properties:
uuid:
type: string
format: uuid
description: The sender UUID
message:
type: string
description: The message to send
maxLength: 256
PrivateMessageRequest:
type: object
required:
- from
- message
- to
properties:
from:
type: string
format: uuid
description: The sender UUID
message:
type: string
description: The message to send
maxLength: 256
to:
type: string
format: uuid
description: The recipient UUID
PartyMessageRequest:
type: object
required:
- from
- message
- partyId
properties:
from:
type: string
format: uuid
description: The sender UUID
message:
type: string
description: The message to send
maxLength: 256
partyId:
type: string
format: int32
description: The party id
PunishRequest:
type: object
required:
- executor
- target
- type
- reason
properties:
executor:
type: string
format: uuid
description: The executor UUID
target:
type: string
format: uuid
description: The target UUID
type:
type: string
description: The type of punishment
enum:
- BAN
- MUTE
- WARN
- FLAG
reason:
type: string
description: The reason for the punishment
time:
type: string
format: duration
example: PT30S