Extend randomizationInterval apidocs

Signed-off-by: David Schwilk <david.schwilk@bosch.io>
eclipse-ditto · Aug 9, 2022 · f5f8bc9 · f5f8bc9
1 parent d835af5
commit f5f8bc9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/documentation/src/main/resources/openapi/ditto-api-2.yml b/documentation/src/main/resources/openapi/ditto-api-2.yml
@@ -7534,7 +7534,10 @@ components:
             timeout: 5s
         randomizationInterval:
           type: string
-          description: Interval in which the announcement can be sent earlier in effort to prevent announcement peaks.
+          minimum: 0ms
+          maximum: 2562047788015215h
+          default: 5m
+          description: 'Interval in which the announcement can be sent earlier in effort to prevent announcement peaks. If omitted, the default value will be applied. If set to minimum, no randomization will be applied.'
       example:
         beforeExpiry: 5m
         whenDeleted: true

diff --git a/documentation/src/main/resources/openapi/sources/schemas/policies/subjectAnnouncement.yml b/documentation/src/main/resources/openapi/sources/schemas/policies/subjectAnnouncement.yml
@@ -36,7 +36,10 @@ properties:
       timeout: "5s"
   randomizationInterval:
     type: string
-    description: Interval in which the announcement can be sent earlier in effort to prevent announcement peaks.
+    minimum: "0ms"
+    maximum: "999_999_999s"
+    default: "5m"
+    description: Interval in which the announcement can be sent earlier in effort to prevent announcement peaks. If omitted, the default value will be applied. If set to minimum, no randomization will be applied.
 example:
   beforeExpiry: "5m"
   whenDeleted: true