JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog REST Workers API

8 actions 8 updates phrasing extends openapi/jfrog-workers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for JFrog's API. It is a proposal applied on top of the contract, not a document JFrog publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/v1/workers'].get
$.paths['/v1/workers'].post
$.paths['/v1/workers/{workerKey}'].get
$.paths['/v1/workers/{workerKey}'].put
$.paths['/v1/workers/{workerKey}'].delete
$.paths['/v1/workers/{workerKey}/enable'].put
$.paths['/v1/workers/{workerKey}/disable'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for JFrog REST Workers API
  version: 1.0.0
extends: openapi/jfrog-workers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v1/workers'].get
  update:
    x-apievangelist-phrasing:
      intent: List workers
      effect: read
      questions:
      - Which serverless workers are registered on my platform?
      - Can I see all workers and whether they're enabled?
      instructions:
      - text: List all workers.
      - text: Show every registered serverless worker.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a serverless worker
      effect: write
      questions:
      - How do I deploy a TypeScript worker that runs on a platform event?
      - Can I give a new worker secrets and filter criteria?
      instructions:
      - text: Create worker {key} for action {action} with source {source_code}.
        slots:
          key: requestBody.key
          action: requestBody.action
          source_code: requestBody.source_code
      - text: Deploy worker {key} on {action} using code {source_code} and secrets {secrets}.
        slots:
          key: requestBody.key
          action: requestBody.action
          source_code: requestBody.source_code
          secrets: requestBody.secrets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workers/{workerKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a worker
      effect: read
      questions:
      - How do I view a worker's code and configuration?
      - What action is a specific worker bound to?
      instructions:
      - text: Show worker {workerKey}.
        slots:
          workerKey: path.workerKey
      - text: Get the configuration of worker {workerKey}.
        slots:
          workerKey: path.workerKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workers/{workerKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a worker's code or config
      effect: write
      questions:
      - How do I push new code to an existing worker?
      - Can I change which action a worker runs on?
      instructions:
      - text: Update worker {workerKey} with new source {source_code}.
        slots:
          workerKey: path.workerKey
          source_code: requestBody.source_code
      - text: Change worker {workerKey} to key {key}, action {action}, code {source_code}.
        slots:
          workerKey: path.workerKey
          key: requestBody.key
          action: requestBody.action
          source_code: requestBody.source_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workers/{workerKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a worker
      effect: destructive
      questions:
      - How do I remove a worker I no longer need?
      - Can I delete a worker by its key?
      instructions:
      - text: Delete worker {workerKey}.
        slots:
          workerKey: path.workerKey
      - text: Remove the {workerKey} worker.
        slots:
          workerKey: path.workerKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workers/{workerKey}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable a worker
      effect: write
      questions:
      - How do I turn a disabled worker back on?
      - Can I re-activate a worker without redeploying its code?
      instructions:
      - text: Enable worker {workerKey}.
        slots:
          workerKey: path.workerKey
      - text: Turn worker {workerKey} back on.
        slots:
          workerKey: path.workerKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workers/{workerKey}/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Disable a worker
      effect: write
      questions:
      - How do I pause a worker without deleting it?
      - Can I temporarily stop a worker from running?
      instructions:
      - text: Disable worker {workerKey}.
        slots:
          workerKey: path.workerKey
      - text: Pause worker {workerKey}.
        slots:
          workerKey: path.workerKey
      method: generated
      generated: '2026-10-01'