JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Connect REST Devices API

4 actions 4 updates phrasing extends openapi/jfrog-devices-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 4

$.info
$.paths['/projects/{projectId}/devices'].get
$.paths['/projects/{projectId}/devices/{deviceId}'].get
$.paths['/projects/{projectId}/devices/{deviceId}'].delete

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 Devices API
  version: 1.0.0
extends: openapi/jfrog-devices-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: 3
- target: $.paths['/projects/{projectId}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices in a project
      effect: read
      questions:
      - Which devices are registered in my project?
      - Can I filter devices by status or device group?
      instructions:
      - text: List devices in project {projectId}.
        slots:
          projectId: path.projectId
      - text: List {status} devices in group {group_id} of project {projectId}.
        slots:
          status: query.status
          group_id: query.group_id
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/devices/{deviceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device
      effect: read
      questions:
      - How do I see the details of one device?
      - What status does a specific device report?
      instructions:
      - text: Show device {deviceId} in project {projectId}.
        slots:
          deviceId: path.deviceId
          projectId: path.projectId
      - text: Get details for device {deviceId} of {projectId}.
        slots:
          deviceId: path.deviceId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/devices/{deviceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a device from a project
      effect: destructive
      questions:
      - How do I remove a decommissioned device from a project?
      - Can I take a device out of my project?
      instructions:
      - text: Remove device {deviceId} from project {projectId}.
        slots:
          deviceId: path.deviceId
          projectId: path.projectId
      - text: Decommission device {deviceId} in {projectId}.
        slots:
          deviceId: path.deviceId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'