JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Pipelines REST Node Pools API

5 actions 5 updates phrasing extends openapi/jfrog-node-pools-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['/v1/nodePools'].get

$.paths['/v1/nodePools'].post

$.paths['/v1/nodePools/{nodePoolId}'].get

$.paths['/v1/nodePools/{nodePoolId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for JFrog Pipelines REST Node Pools API
  version: 1.0.0
extends: openapi/jfrog-node-pools-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['/v1/nodePools'].get
  update:
    x-apievangelist-phrasing:
      intent: List build node pools
      effect: read
      questions:
      - Which build node pools are configured for Pipelines?
      - Can I see all my node pools?
      instructions:
      - text: List all node pools.
      - text: Show every build node pool.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/nodePools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a build node pool
      effect: write
      questions:
      - How do I create an on-demand pool of build nodes?
      - Can I choose the OS and architecture for a node pool?
      instructions:
      - text: Create node pool {name} with {numberOfNodes} nodes.
        slots:
          name: requestBody.name
          numberOfNodes: requestBody.numberOfNodes
      - text: Create node pool {name} on {operatingSystem} {architecture}, on-demand {isOnDemand}.
        slots:
          name: requestBody.name
          operatingSystem: requestBody.operatingSystem
          architecture: requestBody.architecture
          isOnDemand: requestBody.isOnDemand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/nodePools/{nodePoolId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build node pool
      effect: read
      questions:
      - How many nodes does a specific pool have?
      - What OS does one node pool run?
      instructions:
      - text: Show node pool {nodePoolId}.
        slots:
          nodePoolId: path.nodePoolId
      - text: Get the details of node pool {nodePoolId}.
        slots:
          nodePoolId: path.nodePoolId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/nodePools/{nodePoolId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a build node pool
      effect: destructive
      questions:
      - How do I remove a node pool I no longer use?
      - Can I delete a node pool by its ID?
      instructions:
      - text: Delete node pool {nodePoolId}.
        slots:
          nodePoolId: path.nodePoolId
      - text: Remove build node pool {nodePoolId}.
        slots:
          nodePoolId: path.nodePoolId
      method: generated
      generated: '2026-10-01'