Latchkey Jobs API · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the Latchkey Jobs API

5 actions 5 updates update extends openapi/latchkey-jobs-api-openapi.json
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-idempotencyx-apievangelistx-rate-limitx-reversibilityx-scopes

Targets 5

$.info
$.paths['/jobs'].post
$.paths['/jobs/{id}/submit'].post
$.paths['/jobs/{id}/cancel'].post
$.components.securitySchemes.latchkeyApiKey

OpenAPI Overlay

Raw ↑ 
# generated: 2026-09-07 | method: generated | source: openapi/latchkey-jobs-api-openapi.json
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Latchkey Jobs API
  version: 1.0.0
extends: openapi/latchkey-jobs-api-openapi.json
actions:
  - target: $.info
    update:
      x-apievangelist:
        slug: latchkey
        profiled: '2026-09-07'
        artifacts:
          conventions: conventions/latchkey-conventions.yml
          errors: errors/latchkey-problem-types.yml
          rate-limits: rate-limits/latchkey-rate-limits.yml
          mcp: mcp/latchkey-mcp.yml
          tool-crosswalk: mcp/latchkey-tool-crosswalk.yml
  - target: $.paths['/jobs'].post
    update:
      x-rate-limit:
        scope: per-workspace
        limit: 120
        window: 1h
        exhaustion_status: 429
      x-idempotency:
        supported: false
        note: a retried create makes a second job; no Idempotency-Key mechanism
  - target: $.paths['/jobs/{id}/submit'].post
    update:
      x-idempotency:
        supported: replay-guarded
        note: only state `created` may be submitted; a replayed submit returns 409
      x-reversibility:
        reversal_operation: cancelJob
        window: any time before the job reaches a terminal state
  - target: $.paths['/jobs/{id}/cancel'].post
    update:
      x-idempotency:
        supported: true
        note: documented "Cancellation is idempotent"
  - target: $.components.securitySchemes.latchkeyApiKey
    update:
      x-scopes:
        - jobs:read
        - jobs:run