JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Connect REST Commands API

3 actions 3 updates phrasing extends openapi/jfrog-commands-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 3

$.info
$.paths['/projects/{projectId}/commands'].post
$.paths['/projects/{projectId}/commands/{commandId}'].get

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 Connect REST Commands API
  version: 1.0.0
extends: openapi/jfrog-commands-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: 2
- target: $.paths['/projects/{projectId}/commands'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a remote command on devices
      effect: write
      questions:
      - How do I run a shell command on several devices at once?
      - Can I set a timeout on a remote command sent to a device group?
      instructions:
      - text: Run {command} on devices {device_ids} in project {projectId}.
        slots:
          command: requestBody.command
          device_ids: requestBody.device_ids
          projectId: path.projectId
      - text: In project {projectId}, execute {command} on groups {group_ids} with a {timeout_seconds}-second timeout.
        slots:
          projectId: path.projectId
          command: requestBody.command
          group_ids: requestBody.group_ids
          timeout_seconds: requestBody.timeout_seconds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/commands/{commandId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a remote command's status
      effect: read
      questions:
      - Did the remote command I sent to my devices succeed?
      - Can I see the output of a remote command execution?
      instructions:
      - text: Get the status of command {commandId} in project {projectId}.
        slots:
          commandId: path.commandId
          projectId: path.projectId
      - text: Show me the results of remote command {commandId} in {projectId}.
        slots:
          commandId: path.commandId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'