diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/openapi/components.yml | 19 | ||||
| -rw-r--r-- | docs/openapi/openapi.yml | 14 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 16 | ||||
| -rw-r--r-- | docs/tox.ini | 6 |
5 files changed, 37 insertions, 20 deletions
diff --git a/docs/index.rst b/docs/index.rst index bc299aeb..54da6148 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ .. Copyright (C) 2021 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING -.. _dmi: +.. _master_index: .. THIS IS USED INTERNALLY IN CPS ONLY .. _dmi-framework-doc: diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml index 3866b834..9cce52de 100644 --- a/docs/openapi/components.yml +++ b/docs/openapi/components.yml @@ -19,12 +19,14 @@ components: items: type: string - DmiReadRequestBody: + DmiModuleReadRequestBody: type: object properties: operation: type: string enum: [read] + dataType: + type: string data: type: object properties: @@ -58,6 +60,21 @@ components: namespace: type: string + YangResources: + type: array + items: + type: object + $ref: '#/components/schemas/YangResource' + + YangResource: + properties: + yangSource: + type: string + moduleName: + type: string + revision: + type: string + DataAccessReadRequest: type: object properties: diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml index a9accdb9..f66897a2 100644 --- a/docs/openapi/openapi.yml +++ b/docs/openapi/openapi.yml @@ -45,6 +45,12 @@ paths: required: true schema: type: string + requestBody: + description: Operational body + content: + application/json: + schema: + $ref: 'components.yml#/components/schemas/DataAccessReadRequest' responses: '200': description: OK @@ -107,10 +113,14 @@ paths: content: application/json: schema: - $ref: 'components.yml#/components/schemas/DmiReadRequestBody' + $ref: 'components.yml#/components/schemas/DmiModuleReadRequestBody' responses: '200': - $ref: 'components.yml#/components/responses/Ok' + description: OK + content: + application/json: + schema: + $ref: 'components.yml#/components/schemas/YangResources' '400': $ref: 'components.yml#/components/responses/BadRequest' '401': diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index b3188ddd..5a3d2f17 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,15 +1 @@ -tox -Sphinx -doc8 -docutils -setuptools -six -sphinx_rtd_theme>=0.4.3 -sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag -sphinxcontrib-swaggerdoc -sphinxcontrib-plantuml -sphinx_bootstrap_theme -lfdocs-conf +lfdocs-conf
\ No newline at end of file diff --git a/docs/tox.ini b/docs/tox.ini index edac8c35..4e9449e2 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -6,6 +6,8 @@ skipsdist = true [testenv:docs] basepython = python3 deps = -r{toxinidir}/requirements-docs.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" @@ -16,7 +18,9 @@ whitelist_externals = [testenv:docs-linkcheck] basepython = python3 -#deps = -r{toxinidir}/requirements-docs.txt +deps = -r{toxinidir}/requirements-docs.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.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 whitelist_externals = echo |