Skip to content

docs: add examples for the cancel, approve, deny and test actions - #66

Merged
cigamit merged 3 commits into
ctrliq:mainfrom
blaipr:docs/cli-action-examples
Sep 13, 2026
Merged

cigamit merged 3 commits into
ctrliq:mainfrom
blaipr:docs/cli-action-examples

Conversation

@blaipr

@blaipr blaipr commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

#61 gave relaunch a section in the CLI usage examples. #62, #63, #64 and #65 added cancel, approve, deny and test without one, so the only place those four appear is reference.rst, and that page is generated by sphinxcontrib-autoprogram from a live server's OPTIONS metadata rather than from anything in the tree. A reader of the docs as checked in finds nothing about them.

Three sections, the first two placed after the relaunch one so the job lifecycle examples stay together:

  • Cancelling a Running Job, listing the six resources it works on, and noting that the status printed back can still read running. The platform accepts the request and stops the job shortly after rather than before it answers, which is surprising the first time you see it.
  • Approving or Denying a Workflow Approval, covering both, since they are the two answers to the same question.
  • Testing a Notification Template or a Credential, with more room than the others because --inputs and --metadata are the part a generated signature cannot convey: they carry values that are not saved yet, which is the point of the endpoint, and either one takes JSON or YAML or @ a file holding it.

No CHANGELOG.md entry: the four actions are already in Unreleased from their own pull requests, and this adds no user-facing change of its own.

Verification

reference.rst needs a running Ascender to build, so a full make html is not something CI or this branch can do. What was checked instead:

  • The file parses under docutils, with no new messages. The one error reported is the pre-existing :ref: on line 14, a Sphinx-only role that bare docutils does not know.
  • Every section underline matches its title length, and the prose wraps at the same ~80 columns as the rest of the file.
  • The resource lists and the described behaviour were read back against cli/custom.py and api/resources.py rather than from the pull request descriptions.

Also here: the Dependabot pip comment

Added on request rather than as a separate pull request, so note that it is unrelated to the examples above and the docs: title does not cover it.

.github/dependabot.yml said the pip ecosystem covers "the install_requires and extras_require lists, which Dependabot reads straight out of setup.py". #37 moved the packaging metadata to PEP 621, so those are the dependencies and optional-dependencies tables in pyproject.toml, and setup.py declares neither: it is version resolution only, and contains zero occurrences of either name.

Comment only. Dependabot reads pyproject.toml either way, so nothing about what gets bumped changes. Both ecosystems keep their ci and build prefixes and their labels, verified by parsing the file back.

@ciq-it-service-account

ciq-it-service-account commented Sep 13, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

ctrliq#61 gave relaunch a section in the CLI usage examples. ctrliq#62, ctrliq#63 and ctrliq#64 added
cancel, approve and deny without one, so the only place they appear is the
generated command reference, and that page is built from a live server's OPTIONS
metadata rather than from the tree. Anybody reading the docs as checked in sees
nothing about them.

Cancel gets the list of resources it works on and the note that the status
printed back can still read running, since the platform stops the job shortly
after accepting the request rather than before answering. Approve and deny share
a section, being the two answers to the same question.
ctrliq#65 added test on notification_templates, credentials and credential_types and
landed without an examples entry, the same gap as the three actions above it.

It gets more room than they do because --inputs and --metadata are the part a
generated signature cannot convey: they carry values that are not saved yet,
which is the point of the endpoint, and either one takes JSON or YAML or @ a
file holding it.
@blaipr
blaipr force-pushed the docs/cli-action-examples branch from 0e12f80 to 317b77a Compare September 13, 2026 21:51
@blaipr blaipr changed the title docs: add examples for the cancel, approve and deny actions docs: add examples for the cancel, approve, deny and test actions Sep 13, 2026
The comment said Dependabot reads the install_requires and extras_require lists
straight out of setup.py. ctrliq#37 moved the packaging metadata to PEP 621, so those
lists are the dependencies and optional-dependencies tables in pyproject.toml
and setup.py holds neither: it is version resolution only and declares nothing
to bump.

Comment only. Dependabot reads pyproject either way, so nothing about what gets
bumped changes. The reason to fix it is that the convention keeps these comments
for the reasoning a reviewer cannot reconstruct, and this one pointed at the
wrong file.
@cigamit cigamit self-assigned this Sep 13, 2026
@cigamit cigamit added the enhancement New feature or request label Sep 13, 2026
@cigamit
cigamit merged commit 35c0d23 into ctrliq:main Sep 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Development

Successfully merging this pull request may close these issues.

3 participants