From 5a4c5cf7eb501672e83450cd958a771fc9320434 Mon Sep 17 00:00:00 2001
From: schaerentim <tim.schaeren.1@post.ch>
Date: Mon, 16 Dec 2024 15:19:18 +0100
Subject: [PATCH] add info on state mapping in description

---
 incidentRestAPI.yml | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/incidentRestAPI.yml b/incidentRestAPI.yml
index dc6ba30..8213602 100644
--- a/incidentRestAPI.yml
+++ b/incidentRestAPI.yml
@@ -1,7 +1,16 @@
 openapi: '3.0.2'
 info:
   title: Incident REST API
-  description: handles communication between the MyIT incident system and partner systems.
+  description: |
+    Handles communication between the MyIT incident system and partner systems.
+    
+    **State values:**
+    - New: 1
+    - In progress: 2
+    - On hold: 3
+    - Resolved: 6
+    - Closed: 7
+    - Cancelled: 8
   version: '1.0.0'
 
 servers: