/
citadel-api.yaml
85 lines (85 loc) · 2.13 KB
/
citadel-api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
swagger: '2.0'
info:
version: 1.0.0
title: Citadel API fomr https://stop.hammerti.me.uk
host: stop.hammerti.me.uk
basePath: /api
schemes:
- https
produces:
- application/json
paths:
/citadel/all:
get:
tags:
- Citadel
summary: Retrieve all citadel information
description: ''
operationId: getAllCitadels
responses:
200:
description: citadel info
schema:
type: object
additionalProperties:
$ref: '#/definitions/Citadel'
/citadel/{citadel_id}:
get:
tags:
- Citadel
summary: Retrieve information about a single citadel
description: ''
operationId: getCitadel
parameters:
- name: citadel_id
in: path
description: Unique citadel ID
required: true
type: integer
format: int64
responses:
200:
description: citadel info
schema:
type: object
additionalProperties:
$ref: '#/definitions/Citadel'
definitions:
Citadel:
type: object
properties:
typeId:
type: integer
format: int32
description: Structure type ID
systemId:
type: integer
format: int64
description: System ID of system where structure is located
name:
type: string
description: Structure name
typeName:
type: string
description: Structure type name
lastSeen:
type: string
format: date-time
description: Last time (UTC) structure was seen
systemName:
type: string
description: Name of system where structure is located
regionId:
type: integer
format: int32
description: Region ID of structure location
firstSeen:
type: string
format: date-time
description: Time (UTC) when structure was first seen
regionName:
type: string
description: Name of region where structure is located
public:
type: boolean
description: Whether or not the structure is currently publicly accessible