diff options
| author |   mpriyank <priyank.maheshwari@est.tech> | 2022-09-14 10:47:45 +0100 |
|---|---|---|
| committer | Priyank Maheshwari <priyank.maheshwari@est.tech> | 2022-09-14 12:32:03 +0000 |
| commit | 7b7297c644144f1d6f7e842422c621d5627d475c (patch) | |
| tree | 04ada6cfe549b30df67dbd657bd822b90088d135 | |
| parent | fb2446bae49093015825179db8480336e7d43b65 (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>
| -rw-r--r-- | docs/api/swagger/openapi.yaml | 20 | ||||
| -rw-r--r-- | docs/tox.ini | 8 | ||||
| -rw-r--r-- | openapi/components.yml | 2 |
3 files changed, 25 insertions, 5 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: diff --git a/docs/tox.ini b/docs/tox.ini index 4e9449e2..c329a7e3 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -4,9 +4,9 @@ envlist = docs, skipsdist = true [testenv:docs] -basepython = python3 +basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html @@ -17,9 +17,9 @@ whitelist_externals = sh [testenv:docs-linkcheck] -basepython = python3 +basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt commands = echo "Link Checking not enforced" #commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck diff --git a/openapi/components.yml b/openapi/components.yml index 212ddf03..049701e4 100644 --- a/openapi/components.yml +++ b/openapi/components.yml @@ -201,7 +201,7 @@ components: topicParamInQuery: name: topic in: query - description: valid topic name passed from client(NCMP). + description: topic name passed from client(NCMP). required: false schema: type: string |