docs: add search_process_definition_variable_names example coverage#200
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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
SearchProcessDefinitionVariableNamesregion example inexamples/extended_operations.py. - Added an
operation-map.jsonentry mappingsearch_process_definition_variable_namesto 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds example coverage for the
searchProcessDefinitionVariableNamesoperation (POST /process-definitions/{processDefinitionKey}/variable-names/search, tagProcess definition, added in 8.10), closing the coverage gap reported in #199.SearchProcessDefinitionVariableNamesregion example toexamples/extended_operations.py(alongsideSearchProcessDefinitions), callingclient.search_process_definition_variable_names(process_definition_key=...)and printing eachvariable.name.search_process_definition_variable_namesentry toexamples/operation-map.json.Following the same convention as the merged
change_cluster_modeexample 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 generatedsearch_process_definition_variable_names(process_definition_key, *, data)methodruff checkon the example — cleancheck_example_coverage.py— 100% (198/198), integrity check passesCloses #199