From 16d076f0506e29a71cae1a6d763ecb6950b01ed6 Mon Sep 17 00:00:00 2001 From: Jim Martens Date: Thu, 13 Jul 2023 23:29:24 +0200 Subject: [PATCH] Added custom text to Open API description --- module-server/src/main/resources/application.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/module-server/src/main/resources/application.yaml b/module-server/src/main/resources/application.yaml index acb0ee5..a8f17ed 100644 --- a/module-server/src/main/resources/application.yaml +++ b/module-server/src/main/resources/application.yaml @@ -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'