summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authormpriyank <priyank.maheshwari@est.tech>2022-09-14 10:47:45 +0100
committerPriyank Maheshwari <priyank.maheshwari@est.tech>2022-09-14 12:32:03 +0000
commit7b7297c644144f1d6f7e842422c621d5627d475c (patch)
tree04ada6cfe549b30df67dbd657bd822b90088d135 /docs/api
parentfb2446bae49093015825179db8480336e7d43b65 (diff)
dmi plugin sync openapi yml
- copy target/generated-sources/swagger/openapi.yaml → docs/api/swagger/openapi.yaml - fixed the tox.ini for the documentation build issue - updated description for topic paramter Issue-ID: CPS-1276 Change-Id: I0771fd6b7a8fda5085a535e02cd40fa49e6b8b6f Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger/openapi.yaml20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/api/swagger/openapi.yaml b/docs/api/swagger/openapi.yaml
index a3b07c24..41ebedf8 100644
--- a/docs/api/swagger/openapi.yaml
+++ b/docs/api/swagger/openapi.yaml
@@ -195,6 +195,16 @@ paths:
sample3:
value:
options: (key1=10,key2=value2,key3=val31,val32)
+ - name: topic
+ in: query
+ description: topic name passed from client(NCMP).
+ required: false
+ allowReserved: true
+ schema:
+ type: string
+ examples:
+ sample1:
+ value: my-topic-name
requestBody:
description: Operational body
content:
@@ -277,6 +287,16 @@ paths:
sample3:
value:
options: (key1=10,key2=value2,key3=val31,val32)
+ - name: topic
+ in: query
+ description: topic name passed from client(NCMP).
+ required: false
+ allowReserved: true
+ schema:
+ type: string
+ examples:
+ sample1:
+ value: my-topic-name
requestBody:
content:
application/json: