source: TFP-WebServer/MapRendering/src/MapTileHandler.openapi.yaml@ 501

Last change on this file since 501 was 463, checked in by alloc, 16 months 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.6 KB
Line 
1openapi: 3.1.0
2info:
3 title: MapTileHandler
4 version: '1'
5
6components:
7 parameters:
8 ZoomLevelParameter:
9 name: zoom
10 in: path
11 required: true
12 schema:
13 type: integer
14 minimum: 0
15 description: Zoom level, 0 being most zoomed out
16
17 CoordXParameter:
18 name: x
19 in: path
20 required: true
21 schema:
22 type: integer
23 description: X (east/west) index of the tile
24
25 CoordYParameter:
26 name: y
27 in: path
28 required: true
29 schema:
30 type: integer
31 description: Y (north/south) index of the tile
32
33
34paths:
35 /BASEPATH/{zoom}/{x}/{y}.png:
36 get:
37 tags:
38 - Map
39 summary: MapTile get
40 description: Get a map tile for the given zoom level and tile indexes
41 operationId: MapTileHandler.get.name
42 parameters:
43 - $ref: '#/components/parameters/ZoomLevelParameter'
44 - $ref: '#/components/parameters/CoordXParameter'
45 - $ref: '#/components/parameters/CoordYParameter'
46 responses:
47 200:
48 description: Map tile
49 content:
50 image/png:
51 schema:
52 type: string
53 format: binary
54 404:
55 description: Tile not found
56 content:
57 text/plain:
58 schema:
59 type: string
60 const: ''
61 403:
62 $ref: './openapi.yaml#/components/responses/Unauthorized'
63 security:
64 - apiTokenName: []
65 apiTokenSecret: []
66 - sessionCookie: []
Note: See TracBrowser for help on using the repository browser.