JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Connect REST Device Groups API

5 actions 5 updates phrasing extends openapi/jfrog-device-groups-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 5

$.info
$.paths['/projects/{projectId}/device-groups'].get
$.paths['/projects/{projectId}/device-groups'].post
$.paths['/projects/{projectId}/device-groups/{groupId}'].get
$.paths['/projects/{projectId}/device-groups/{groupId}'].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 Device Groups API
  version: 1.0.0
extends: openapi/jfrog-device-groups-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: 4
- target: $.paths['/projects/{projectId}/device-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List device groups in a project
      effect: read
      questions:
      - Which device groups exist in a project?
      - Can I see how my project's devices are grouped?
      instructions:
      - text: List device groups in project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show all device groups for {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/device-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a device group
      effect: write
      questions:
      - How do I group several devices together in a project?
      - Can I add devices to a group when creating it?
      instructions:
      - text: Create device group {name} in project {projectId}.
        slots:
          name: requestBody.name
          projectId: path.projectId
      - text: Group devices {device_ids} as {name} in project {projectId}.
        slots:
          device_ids: requestBody.device_ids
          name: requestBody.name
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/device-groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device group
      effect: read
      questions:
      - How do I see which devices are in a specific group?
      - What details are stored for one device group?
      instructions:
      - text: Show device group {groupId} in project {projectId}.
        slots:
          groupId: path.groupId
          projectId: path.projectId
      - text: Get the devices in group {groupId} of {projectId}.
        slots:
          groupId: path.groupId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/device-groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device group
      effect: destructive
      questions:
      - How do I delete a device group from a project?
      - Can I remove a device group I no longer need?
      instructions:
      - text: Delete device group {groupId} from project {projectId}.
        slots:
          groupId: path.groupId
          projectId: path.projectId
      - text: Remove group {groupId} in {projectId}.
        slots:
          groupId: path.groupId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'