Skip to content

docs: add search_process_definition_variable_names example coverage#200

Merged
emilyoram merged 2 commits into
mainfrom
docs/search-process-definition-variable-names
Jul 15, 2026
Merged

docs: add search_process_definition_variable_names example coverage#200
emilyoram merged 2 commits into
mainfrom
docs/search-process-definition-variable-names

Conversation

@emilyoram

Copy link
Copy Markdown
Contributor

Description

Adds example coverage for the searchProcessDefinitionVariableNames operation (POST /process-definitions/{processDefinitionKey}/variable-names/search, tag Process definition, added in 8.10), closing the coverage gap reported in #199.

  • Add a SearchProcessDefinitionVariableNames region example to examples/extended_operations.py (alongside SearchProcessDefinitions), calling client.search_process_definition_variable_names(process_definition_key=...) and printing each variable.name.
  • Add the search_process_definition_variable_names entry to examples/operation-map.json.

Following the same convention as the merged change_cluster_mode example PR, this touches only the two hand-written example files. Generated code (generated/, stubs/) and the bundled spec are regenerated fresh by CI and are intentionally not committed here.

Verification

Validated locally by regenerating the SDK from the latest upstream spec (not committed):

  • ty check examples/ — example type-checks against the generated search_process_definition_variable_names(process_definition_key, *, data) method
  • ruff check on the example — clean
  • check_example_coverage.py — 100% (198/198), integrity check passes

Closes #199

Copilot AI review requested due to automatic review settings July 14, 2026 22:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds missing example coverage for the searchProcessDefinitionVariableNames API operation by introducing a new region-tagged example and wiring it into the operation-map.json so coverage tooling and docs can discover it.

Changes:

  • Added a new SearchProcessDefinitionVariableNames region example in examples/extended_operations.py.
  • Added an operation-map.json entry mapping search_process_definition_variable_names to that region.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
examples/operation-map.json Registers the new operationId→example mapping for search_process_definition_variable_names.
examples/extended_operations.py Adds the SearchProcessDefinitionVariableNames region and example function that calls client.search_process_definition_variable_names(...).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread examples/extended_operations.py

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@emilyoram emilyoram merged commit 9f69e01 into main Jul 15, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing example coverage: searchProcessDefinitionVariableNames

2 participants