2martens/wahlrecht
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added custom text to Open API description

Browse Source
This commit is contained in:
2martens
2023-07-13 23:29:24 +02:00
parent 3388969a56
commit 16d076f050
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
module-server/src/main/resources/application.yaml
+6 -5
View File
@@ -47,19 +47,20 @@ springdoc:
path: '/wahlrecht/v1/api-docs'
openapi:
#TODO write description/ changelog
description: |
Open API Documentation for the Wahlrecht
Open API Documentation for the Wahlrecht API
## Header 2
## Calculate election results
__YOUR TEXT HERE__
If you want to calculate the result of the 2019 district election in Hamburg-Eimsbüttel,
first GET it with /wahlrecht/v1/electionResult/by-election-name/Bezirkswahl%202019,
and then POST it to /wahlrecht/v1/calculate.
## Changelog
|Version | Change | Author | Date |
| ------ | -------------------------------------- | ------ | ---------- |
| 1.0 | added API Versioning (and changelog) | Jim | 28.05.2023 |
| 1.0 | added API Versioning (and changelog) | Jim | 13.07.2023 |
version: 1.0
title: 'Wahlrecht API'