From ae904cc8563fb94f594a2f47078ce749d7081235 Mon Sep 17 00:00:00 2001
From: Sofia Shnaidman <sshnaidman@provectus.com>
Date: Thu, 3 Dec 2020 17:50:39 +0300
Subject: [PATCH] Updated contract.

---
 .../src/main/resources/swagger/kafka-ui-api.yaml              | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/kafka-ui-contract/src/main/resources/swagger/kafka-ui-api.yaml b/kafka-ui-contract/src/main/resources/swagger/kafka-ui-api.yaml
index 89acbb29ac..538aceca97 100644
--- a/kafka-ui-contract/src/main/resources/swagger/kafka-ui-api.yaml
+++ b/kafka-ui-contract/src/main/resources/swagger/kafka-ui-api.yaml
@@ -269,11 +269,12 @@ paths:
             type: array
             items:
               type: string
-          description: The format is [partition]::[offset] for specifying offsets or [partition]::[timstamp in millis] for specifying timestamps
+              description: The format is [partition]::[maximum offset] for specifying offsets or [partition]::[maximum timestamp in milliseconds] for specifying timestamps
         - name: limit
           in: query
           schema:
             type: integer
+          description: Maximum amount of messages for each partition
         - name: q
           in: query
           schema:
@@ -287,6 +288,7 @@ paths:
                 type: array
                 items:
                   $ref: '#/components/schemas/TopicMessage'
+                description: Array of topic messages sorted in descending order by offset or timestamp
 
   /api/clusters/{clusterName}/consumer-groups/{id}:
     get: