forked from e-gov/RIHA-API
-
Notifications
You must be signed in to change notification settings - Fork 0
/
RIHA-API.yaml
126 lines (119 loc) · 3.75 KB
/
RIHA-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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
swagger: '2.0'
info:
version: "0.0.7"
title: RIHA-API
description: Liides andmete avaldamiseks Riigi Infosüsteemi osiste kohta. Iga Riigi Infosüsteemi mõnd osa haldav asutus publitseerib info tema valduses olevate süsteemide ning registrite kohta vähemalt ühes RIHA-API instantsis. Liidese võtmesõnad on rahvusvahelise koosvõime huvides ingliskeelsed.
Kõik ajamärgendid on UTC ajavööndis.
license:
name: MIT
schemes:
- http
consumes:
- application/json
produces:
- application/json
paths:
/systems.json:
get:
description: Tagastab nimekirja käesolevale instantsile teadaolevatest infosüsteemidest
responses:
'200':
description: Kõik läks hästi
schema:
type: array
items:
$ref: '#/definitions/system'
/{shortname}:
get:
description: Tagastab detailse info konkreetse infosüsteemi kohta
parameters:
- name: shortname
in: path
description: Viidatava infosüsteemi lühinimi
required: true
type: string
responses:
'200':
description: Süsteem leidus, info tagastatakse
schema:
$ref: '#/definitions/detailed_system'
'404':
description: Sellenimelist süsteemi ei leidu
definitions:
system:
description: Süsteemi lühiandmestik. Andmed, mis on peamiselt olulised süsteemi elutsükli mõttes
type: object
required:
- uri
- shortname
- owner
properties:
uri:
type: string
description: Süsteemi unikaalselt identifitseeriv URI. HTTP GET sellel aadressil peab tagastama detailed_system tüüpi objekti
name:
type: string
description: Süsteemi täispikk, ametlik, nimi
shortname:
type: string
description: Süsteemi lühinimi
owner:
type: object
required:
- code
properties:
code:
type: string
description: Süsteemi vastutava töötleja registrikood
name:
type: string
description: Süsteemi vastutava töötleja nimi
documentation:
type: string
description: URL, mis viitab süsteemi dokumentatsiooni avalikule asukohale
meta:
type: object
properties:
system_status:
type: object
description: Süsteemi olek
properties:
status:
type: string
description: Staatuse tekstiline kirjeldus
timestamp:
type: string
format: date-time
description: Staatuse saamise aeg
approval_status:
type: object
description: Süsteemi kooskõlastuse olek
properties:
status:
type: string
description: Staatuse tekstiline kirjeldus
timestamp:
type: string
format: date-time
description: Staatuse saamise aeg
description_timestamp:
type: string
format: date-time
description: Süsteemi kohta väljastatava info viimase muutmise aeg
detailed_system:
type: object
required:
- shortname
- description_timestamp
description: Süsteemi detailsed andmed. Andmed, mis on peamiselt olulised süsteemi kooskõlastusprotsessis
properties:
shortname:
type: string
description: Süsteemi lühinimi
description_timestamp:
type: string
format: date-time
description: Kirje viimase muutmise aeg
payload:
type: object
description: Spetsifitseerimata struktuuriga masinloetav informatsioon süsteemi kohta