add info on state mapping in description

timschaeren · timschaeren · commit 5a4c5cf7eb50 · 2024-12-16T15:19:18.000+01:00
diff --git 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:
