openstack/designate-specs
Code Issues Proposed changes

Cleanup docs and py27 building

Browse Source 
* Use sphinx-build to follow PTI
* Remove obsolete section from setup.cfg
* Cleanup tox.ini
* Update pbr requirement
* Fix build problems: Lexing of http failed.

Change-Id: I7b52e9e1f8eff7402a89066a264c967b4c1e536d
This commit is contained in:
Andreas Jaeger 2020-06-03 21:32:47 +02:00
parent 6522b73132
commit 072a55d800
7 changed files with 27 additions and 41 deletions

2
requirements.txt

@ -1,4 +1,4 @@
pbr>=0.6,<1.0
pbr!=2.1.0,>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
yasfb>=0.5.1

11
setup.cfg

@ -11,14 +11,3 @@ classifier =
Intended Audience :: Developers
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[pbr]
warnerrors = True
[upload_sphinx]
upload-dir = doc/build/html

2
setup.py

@ -18,5 +18,5 @@
import setuptools
setuptools.setup(
setup_requires=['pbr>=0.6,<1.0'],
setup_requires=['pbr>=2.0'],
pbr=True)

12
specs/juno/filtering.rst

@ -116,7 +116,7 @@ This call is for a privileged user filtering recordsets by name, for one tenant,
Request:
.. code-block:: http
.. code-block::
GET zones/{zone-id}/recordsets?name=example*
Host: dns.provider.com
@ -124,7 +124,7 @@ Request:
Response:
.. code-block:: http
.. code-block::
{
"recordsets": [
@ -180,7 +180,7 @@ This call is for customers filtering recordsets by name, using exact matching.
Request:
.. code-block:: http
.. code-block::
GET zones/{zone-id}/recordsets?name=www.example.org.
Host: dns.provider.com
@ -188,7 +188,7 @@ Request:
Response:
.. code-block:: http
.. code-block::
{
"recordsets": [
@ -230,7 +230,7 @@ The data parameter can be used in conjunction with other parameters.
Request:
.. code-block:: http
.. code-block::
GET zones/{zone-id}/recordsets?data=1.2.3.*
Host: dns.provider.com
@ -238,7 +238,7 @@ Request:
Response:
.. code-block:: http
.. code-block::
{
"recordsets": [

22
specs/kilo/secondary-zones.rst

@ -69,7 +69,7 @@ When creating a new zone the *managed_resource_email* is used as the initial *em
The fields *version* will be *1* since it's not yet transferred and *transferred_at* as *null*.
.. code-block:: http
.. code-block::
POST /v2/zones HTTP/1.1
Host: 127.0.0.1:9001
@ -85,7 +85,7 @@ The fields *version* will be *1* since it's not yet transferred and *transferred
}
}
.. code-block:: http
.. code-block::
HTTP/1.1 201 Created
Content-Type: application/json
@ -120,7 +120,7 @@ Retrieves a secondary zone with the specified ID.
Example of GET on a untransferred zone:
.. code-block:: http
.. code-block::
GET /v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3 HTTP/1.1
@ -128,7 +128,7 @@ Example of GET on a untransferred zone:
Accept: application/json
Content-Type: application/json
.. code-block:: http
.. code-block::
HTTP/1.1 200 OK
Vary: Accept
@ -164,14 +164,14 @@ To filter on zone type do type=<PRIMARY|SECONDARY> as query parameters.
Below there is examples of a Zone that's not transferred yet and one that is.
.. code-block:: http
.. code-block::
GET /v2/zones?type=SECONDARY HTTP/1.1
Host: 127.0.0.1:9001
Accept: application/json
Content-Type: application/json
.. code-block:: http
.. code-block::
HTTP/1.1 200 OK
Vary: Accept
@ -241,7 +241,7 @@ editable.
+-------------+--------------------------+
.. code-block:: http
.. code-block::
PATCH /v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3 HTTP/1.1
Host: 127.0.0.1:9001
@ -254,7 +254,7 @@ editable.
}
}
.. code-block:: http
.. code-block::
HTTP/1.1 200 OK
Content-Type: application/json
@ -284,12 +284,12 @@ editable.
Delete Secondary Zone
^^^^^^^^^^^^^^^^^^^^^
.. code-block:: http
.. code-block::
DELETE /v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3 HTTP/1.1
Host: 127.0.0.1:9001
.. code-block:: http
.. code-block::
HTTP/1.1 204 No Content
@ -426,4 +426,4 @@ Work Items
Dependencies
============
- :ref:`zone_import_refactor`
- :ref:`zone_import_refactor`

12
specs/kilo/server-pools-api.rst

@ -61,7 +61,7 @@ GET /v2/pools
When no id is specified, all pools are returned. No body is provided in the
request.
.. code-block:: http
.. code-block::
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
@ -100,7 +100,7 @@ GET /v2/pools/{pool_id}
When an id is provided in the url, the specific pool is returned with more
detail. No body is provided in the request.
.. code-block:: http
.. code-block::
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
@ -143,7 +143,7 @@ code will be 409 Conflict.
**Request**
.. code-block:: http
.. code-block::
HTTP/1.1
Content-Type: application/json; charset=UTF-8
@ -168,7 +168,7 @@ code will be 409 Conflict.
**Response**
.. code-block:: http
.. code-block::
HTTP/1.1 201 Created
Content-Type: application/json; charset=UTF-8
@ -205,7 +205,7 @@ returned.
**Request**
.. code-block:: http
.. code-block::
HTTP/1.1
Content-Type: application/json; charset=UTF-8
@ -221,7 +221,7 @@ returned.
**Response**
.. code-block:: http
.. code-block::
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

7
tox.ini

@ -4,20 +4,18 @@ envlist = pep8,docs
skipsdist = True
[testenv]
basepython = python3
usedevelop = True
install_command = pip install -U {opts} {packages}
setenv =
VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/requirements.txt
passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
[testenv:venv]
basepython = python3
commands = {posargs}
[testenv:docs]
basepython = python3
commands = python setup.py build_sphinx
commands = sphinx-build -W -a -b html doc/source doc/build/html
[testenv:spelling]
deps =
@ -27,7 +25,6 @@ deps =
commands = sphinx-build -b spelling doc/source doc/build/spelling
[testenv:pep8]
basepython = python3
commands = flake8
[flake8]