Skip to content

Missing example coverage: restore #197

Description

@camunda-sdk-automation

Operations missing example coverage

Operation Method Path Added in Tag
restore POST /restore 8.10 Recovery

Add an operation-map.json entry and example code for each operation listed above.

How to resolve (coding agents: follow this exactly)

  1. Read AGENTS.md in this repo before writing any code and follow it strictly. Also read .github/prompts/add-missing-examples.prompt.md if present — it documents the example conventions in detail.
  2. Never hand-edit generated code (generated/ and stubs/). If the SDK does not yet expose an operation, regenerate from the spec by running the repo pipeline make generate, and commit the regenerated output in a separate commit from hand-written changes (see AGENTS.md for the two-commit rule).
  3. For each operation: add a region-tagged example in examples/, copying the exact structure of an existing example in the matching domain file, and add an examples/operation-map.json entry referencing it. When an ergonomic helper method exists for the operation, point the entry at the helper (e.g. a file-path deploy helper), not the raw generated method — users should see the best developer experience by default.
  4. Commit messages must pass commitlint (Conventional Commits): an allowed type (feat, chore, docs, ...), lower-case imperative subject, 5-100 characters. Do not use fix: for anything that is not a user-facing bug fix, and never add BREAKING CHANGE: markers - both trigger releases.
  5. Before opening the PR, run make generate && make lint && make typecheck && make test locally and make sure it passes end to end — it regenerates the SDK, type-checks the examples, and runs the repo's build, coverage, and test checks.
  6. Regenerating pulls the latest upstream spec, so the build may surface changes unrelated to your example — new required fields, renamed types, or a stale API baseline. Resolving that drift (for example refreshing a public-API baseline) is expected and belongs in the same PR: a small example change can legitimately require a baseline or test update.

Auto-generated by the daily new operations check. This issue is updated automatically as coverage changes and closed once every listed operation is covered.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions