generated from bundesAPI/api-doc-template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi_en.yaml
220 lines (219 loc) · 7.72 KB
/
openapi_en.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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
openapi: "3.0.0"
info:
description: "Mit unserem Tool „Bundeshaushalt digital“ können Sie sich eine visualisierte Darstellung der Haushaltsdaten der letzten Jahre anzeigen lassen. Sie können sowohl Ausgaben und Einnahmen als auch Soll- und Ist-Werte abrufen und mithilfe des Jahresvergleichs gegenüberstellen. Zudem steht Ihnen eine Vielzahl weiterer Filteroptionen zur Verfügung.<br>"
version: "1.0.0"
title: "Bundeshaushalt API"
contact:
name: "anetz89"
email: "anetz@gmx.net"
url: "https://github.com/anetz89/bundeshaushalt-api"
servers:
- url: "https://bundeshaushalt.de"
paths:
/internalapi/budgetData:
get:
summary: "Anfrage von Budgetdaten des Bundeshaushalts."
description: "Haupteinstiegspunkt für alle Anfragen."
operationId: "budgetData"
tags:
- budgetData
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BudgetDataResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'404':
description: Not Found
parameters:
- in: query
name: year
description: "Haushaltsjahr"
example: 2021
required: true
schema:
type: integer
enum:
- 2012
- 2013
- 2014
- 2015
- 2016
- 2017
- 2018
- 2019
- 2020
- 2021
- in: query
name: quota
description: "<b>target</b>: Sollwerte <i>(default)</i><br><b>actual</b>: Istwerte."
example: "actual"
required: false
schema:
type: string
enum:
- "actual"
- "target"
- in: query
name: account
description: "<b>income</b>: Einnahmen. Die Einnahmen des Bundes setzen sich aus Steuern, sonstigen Einnahmen und Krediten zusammen.<br><b>expenses</b>: Ausgaben. Der größte Teil der Ausgaben wird für Sozialausgaben geleistet. Weitere große Ausgabeposten sind die Ausgabebereiche Verteidigung, Verkehrs- und Nachrichtenwesen und auch Bildung und Forschung."
example: "expenses"
required: true
schema:
type: string
enum:
- "expenses"
- "income"
- in: query
name: unit
description: "<b>single</b>: Einzelplan. <i>(default)</i><br><b>function</b>: Funktion.<br><b>group</b>: Gruppe."
example: "function"
required: false
schema:
type: string
enum:
- "single"
- "function"
- "group"
- in: query
name: id
description: "ID, die sich aus der Budgetnummer ergibt. Die Budgetnummer ist eine numerische Bezeichnung im Rahmen der Gliederung des Haushaltsplans, die sich aus der Einzelplan-, Kapitel und Titelnummer zusammensetzt. Gruppen-IDs starten mit 'G-', Funktions-IDs mit 'F-'"
example: "090168301"
required: false
schema:
type: string
components:
schemas:
BadRequest:
type: object
properties:
timestamp:
type: string
example: "2022-05-23T19:19:45.655+00:00"
status:
type: number
example: 400
error:
type: string
example: "Bad Request"
path:
type: string
example: "/api/budgetData"
BudgetDataResponse:
type: object
properties:
meta:
type: object
description: "Metainformationen zur Anfrage"
properties:
account:
type: string
example: "expenses"
entity:
type: string
example: "Budget"
levelCur:
type: integer
example: 0
levelMax:
type: integer
example: 3
modifyDate:
type: string
example: "04/07/2022"
quota:
type: string
example: "target"
timestamp:
type: integer
example: 1649337498000
unit:
type: string
example: "single"
year:
type: integer
example: 2021
details:
$ref: '#/components/schemas/BudgetElement'
children:
type: array
description: "Liste aller Kindelemente zum angefragten Element."
items:
$ref: '#/components/schemas/BudgetElement'
parents:
type: array
description: "Liste aller Elternelemente zum angefragten Element, inklusive aller Geschwister und Elterngeschwistern usw."
items:
type: array
items:
$ref: '#/components/schemas/LabeledElement'
related:
type: object
properties:
agency:
type: array
description: "Agenturen die zum angefragten Element Bezug haben."
items:
type: array
items:
$ref: '#/components/schemas/LabeledElement'
function:
type: array
description: "Funktionen die zum angefragten Element Bezug haben."
items:
type: array
items:
$ref: '#/components/schemas/LabeledElement'
group:
type: array
description: "Gruppen die zum angefragten Element Bezug haben."
items:
type: array
items:
$ref: '#/components/schemas/LabeledElement'
LabeledElement:
type: object
properties:
id:
type: string
description: "ID, die sich aus der Budgetnummer generiert. Diese ID kann für konkrete Anfragen verwendet werden (query parameter 'id'). ID ist nur in den Children-Objekten gefüllt."
example: "12"
label:
type: string
description: "Beschreibungstext für das Detailobjekt"
example: "Bundesministerium für Verkehr und digitale Infrastruktur"
BudgetElement:
type: object
properties:
budgetNumber:
type: string
description: "Budgetnummer für das Detailobjekt. Die Budgetnummer ist eine numerische Bezeichnung im Rahmen der Gliederung des Haushaltsplans, die sich aus der Einzelplan-, Kapitel und Titelnummer zusammensetzt"
example: "____ ___ __ - ___"
id:
type: string
description: "ID, die sich aus der Budgetnummer generiert. Diese ID kann für konkrete Anfragen verwendet werden (query parameter 'id'). ID ist nur in den Children-Objekten gefüllt."
example: "11"
label:
type: string
description: "Beschreibungstext für das Detailobjekt"
example: "Sollwerte des Haushaltsjahres 2021, inkl. 1. und 2. Nachtragshaushalt"
relativeToParentValue:
type: number
description: "Relativer Budgetwert zum Elternelement"
example: 5.070069604515528
relativeValue:
type: number
description: "Relativer Budgetwert zum Gesamthaushalt des entsprechenden Jahres"
example: 0.20430178267357904
value:
type: number
description: "tatsächlicher Budgetwert in €"
example: 729605430.65
required: ["budgetNumber", "label", "relativeToParentValue", "relativeValue", "value"]