source: TFP-WebServer/MapRendering/src/Api/Map.openapi.yaml@ 507

Last change on this file since 507 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.3 KB
Line 
1openapi: 3.1.0
2info:
3 title: Map
4 version: '1'
5
6components:
7 schemas:
8 MapInfoObject:
9 type: object
10 properties:
11 enabled:
12 type: boolean
13 description: Is map rendering enabled
14 mapBlockSize:
15 type: integer
16 minimum: 2
17 description: Width/height of a single map tile image
18 maxZoom:
19 type: integer
20 description: Maximum supported zoom level on the backend
21 mapSize:
22 $ref: './openapi.yaml#/components/schemas/TypeVector3i'
23 description: Size of the loaded game world
24 required:
25 - enabled
26 - mapBlockSize
27 - maxZoom
28 - mapSize
29
30
31paths:
32 /api/map/config:
33 get:
34 tags:
35 - Map
36 summary: Map info
37 description: Get info about the web map
38 operationId: Map.get.config
39 responses:
40 200:
41 description: Map info
42 content:
43 application/json:
44 schema:
45 type: object
46 properties:
47 data:
48 $ref: '#/components/schemas/MapInfoObject'
49 meta:
50 $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
51 required:
52 - data
53 - meta
Note: See TracBrowser for help on using the repository browser.