source: TFP-WebServer/WebServer/src/WebAPI/APIs/WorldState/Hostile.openapi.yaml@ 468

Last change on this file since 468 was 463, checked in by alloc, 2 years ago

21.1.16.0 release
Completed OpenAPI specs
Add support to path handlers to register OpenAPI specs
Fixed ItemIconHandler throwing error when requested path contains no dot
File size: 1.4 KB
Line 
1openapi: 3.1.0
2info:
3 title: Hostile
4 version: '1'
5
6components:
7 schemas:
8 HostileElement:
9 type: object
10 properties:
11 id:
12 $ref: './openapi.yaml#/components/schemas/TypeEntityId'
13 name:
14 type: string
15 examples:
16 - animalStag
17 position:
18 $ref: './openapi.yaml#/components/schemas/TypeVector3i'
19 required:
20 - id
21 - name
22 - position
23
24 HostileList:
25 type: array
26 items:
27 $ref: '#/components/schemas/HostileElement'
28
29
30paths:
31 /api/hostile:
32 get:
33 tags:
34 - WorldState
35 summary: Hostiles list
36 description: Fetch a list of the currently spawned hostiles - including hostile animals - in the world
37 operationId: Hostile.get
38 responses:
39 200:
40 description: List of hostiles
41 content:
42 application/json:
43 schema:
44 type: object
45 properties:
46 data:
47 $ref: '#/components/schemas/HostileList'
48 meta:
49 $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
50 required:
51 - data
52 - meta
53 403:
54 $ref: './openapi.yaml#/components/responses/Unauthorized'
55 security:
56 - apiTokenName: []
57 apiTokenSecret: []
58 - sessionCookie: []
Note: See TracBrowser for help on using the repository browser.