python-designateclient — Interactions

Interactions — python-designateclient — branch stable/2026.2

Branch stable/2026.2 @ 9231eef90192 — repository https://opendev.org/openstack/python-designateclient — analysed on 2026-11-01

[observed] means seen on the local stub. The stub shows what the client sends, not what a service accepts.

Keystone

OSC authenticates, not the plugin. The plugin takes instance.session (designateclient/osc/plugin.py:39). The token comes once per process, when the first request needs it [observed: tokens_requested is 1 in the scenarios]. On a 401, keystoneauth invalidates the token, fetches a new one and retries once (keystoneauth1:keystoneauth1/session.py:1130) [observed: 401]. The quota commands also read the project of the token: client.session.get_project_id() (designateclient/v2/cli/quotas.py:56).

Endpoint discovery

The adapter is built with service_type='dns', interface, region_name and version='2' (designateclient/v2/client.py:131). keystoneauth therefore looks up the dns catalog entry, then reads the version document.

The warning is in keystoneauth1:keystoneauth1/discover.py:1500. The real document was read in designate:designate/api/versions.py:37.

Designate: request format

build_url always appends ?, even with no parameter (designateclient/client.py:41). It does not reach the wire: the stub logs /dns/v2/zones [observed].

Optional headers

Python str(True) gives the capital.

Routes

The full list is in [api-surface_stable-2026.2.md](_rewrite/api-surface_stable-2026.2.md), per command in 01 § 5.

Filters per list command

Read in Designate, a filter outside the accepted list raises 400 Invalid filters (designate:designate/api/v2/controllers/rest.py:73).

Sample exchanges [observed, stub answers]

$ openstack recordset create 11111111-2222-4333-8444-555555555555 www --type A --record 192.0.2.1 --record 192.0.2.2 --ttl 60 --description d
GET /dns/v2/zones/11111111-2222-4333-8444-555555555555
POST /dns/v2/zones/11111111-2222-4333-8444-555555555555/recordsets
Content-Type: application/json
{"name": "www.example.org.", "type": "A", "records": ["192.0.2.1", "192.0.2.2"], "ttl": 60, "description": "d"}

$ openstack zone import create zone.file --attributes k:v
POST /dns/v2/zones/tasks/imports
Content-Type: application/json
{"zonefile": "$ORIGIN example.org.\n", "attributes": {"k": "v"}}

Local files

zone import create opens the given path in text mode with the default encoding (designateclient/v2/cli/zones.py:736). Nothing else touches the disk. No command runs a binary or reads a terminal; grep on subprocess, getpass and input( outside tests finds nothing.

Python API users

Read in the local clones, not run. They rely on the exception classes and the name resolution of the controllers.

Neutron's edit_managed=True is set at construction, so Client keeps it for all calls; only the commands reset these values.

Not used

Database, AMQP, Redis, gRPC, subprocess: none. In the inventory, the db occurrences are false positives on client.session.delete (designateclient/client.py:84), the config occurrences are the options of the functional tests (designateclient/functionaltests/config.py:21), and the async occurrence is the pagination loop.

Source: reverse-spec-python-designateclient/03-interactions_stable-2026.2.md. The _rewrite/ and _inventory/ files are not published on the site.