From a5e8cce1afd008d828dec7de55c342bd42c38a57 Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Tue, 28 Jul 2020 12:45:09 +0200 Subject: [PATCH] CI: run doc8 on api-ref Change-Id: I000ffe5915a1c74b0e4eeb93ceeb4aee429a1901 --- api-ref/source/introspection-api-versions.inc | 17 +++++++++-------- api-ref/source/parameters.yaml | 18 +++++++++--------- tox.ini | 2 +- 3 files changed, 19 insertions(+), 18 deletions(-) diff --git a/api-ref/source/introspection-api-versions.inc b/api-ref/source/introspection-api-versions.inc index f8086acdc..2e2ed7e22 100644 --- a/api-ref/source/introspection-api-versions.inc +++ b/api-ref/source/introspection-api-versions.inc @@ -14,11 +14,12 @@ Inspector API supports versioning. There are two kinds of versions: - ``microversions``, which can be requested through the use of the ``X-OpenStack-Ironic-Inspector-API-Version`` header. -The Version APIs work differently from other APIs as they *do not* require authentication. +The Version APIs work differently from other APIs as they *do not* require +authentication. -All API requests support the ``X-OpenStack-Ironic-Inspector-API-Version`` header. -This header SHOULD be supplied with every request; in the absence of this header, -server will default to current supported version in all responses. +All API requests support the ``X-OpenStack-Ironic-Inspector-API-Version`` +header. This header SHOULD be supplied with every request; in the absence of +this header, server will default to current supported version in all responses. List API versions ================= @@ -44,8 +45,8 @@ Response Example - links: links - status: status - - x-openstack-ironic-api-min-version: x-openstack-ironic-inspector-api-minimum-version - - x-openstack-ironic-api-max-version: x-openstack-ironic-inspector-api-maximum-version + - x-openstack-ironic-inspector-api-min-version: api-minimum-version + - x-openstack-ironic-inspector-api-max-version: api-maximum-version .. literalinclude:: samples/api-root-response.json :language: javascript @@ -74,8 +75,8 @@ Response Example - rel: rel - name: name - - x-openstack-ironic-api-min-version: x-openstack-ironic-inspector-api-minimum-version - - x-openstack-ironic-api-max-version: x-openstack-ironic-inspector-api-maximum-version + - x-openstack-ironic-inspector-api-min-version: api-minimum-version + - x-openstack-ironic-inspector-api-max-version: api-maximum-version .. literalinclude:: samples/api-v1-root-response.json :language: javascript diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 5b95982cd..b9aef550f 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1,23 +1,23 @@ # variables in header -x-auth-token: - description: | - The client token being passed into Ironic Inspector API to make - authentication. - in: header - required: true - type: string -x-openstack-ironic-inspector-api-maximum-version: +api-maximum-version: description: | Maximum API microversion supported by this endpoint, eg. "1.10" in: header required: true type: string -x-openstack-ironic-inspector-api-minimum-version: +api-minimum-version: description: | Minimum API microversion supported by this endpoint, eg. "1.1" in: header required: true type: string +x-auth-token: + description: | + The client token being passed into Ironic Inspector API to make + authentication. + in: header + required: true + type: string x-openstack-ironic-inspector-api-version: description: > A request SHOULD include this header to indicate to the Ironic Inspector diff --git a/tox.ini b/tox.ini index 76c1d3881..e830f733b 100644 --- a/tox.ini +++ b/tox.ini @@ -44,7 +44,7 @@ commands = [testenv:pep8] commands = flake8 ironic_inspector - doc8 README.rst CONTRIBUTING.rst doc/source + doc8 -e .rst -e .inc README.rst CONTRIBUTING.rst doc/source api-ref/source [testenv:functional-py36] commands =