JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Mission Control REST Scripts API

4 actions 4 updates phrasing extends openapi/jfrog-scripts-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['/v1/scripts'].get
$.paths['/v1/scripts'].post
$.paths['/v1/scripts/{scriptName}/execute'].post

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 Mission Control REST Scripts API
  version: 1.0.0
extends: openapi/jfrog-scripts-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['/v1/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: List execution scripts
      effect: read
      questions:
      - Which execution scripts are available to run on my JPDs?
      - Can I see all scripts in Mission Control?
      instructions:
      - text: List all execution scripts.
      - text: Show every available script.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/scripts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an execution script
      effect: write
      questions:
      - How do I add a new script that can run on my platform deployments?
      - Can I give a script a description when creating it?
      instructions:
      - text: Create script {name} with content {content}.
        slots:
          name: requestBody.name
          content: requestBody.content
      - text: Add script {name} described as {description} using {content}.
        slots:
          name: requestBody.name
          description: requestBody.description
          content: requestBody.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/scripts/{scriptName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a script on platform deployments
      effect: write
      questions:
      - How do I run a script across several JPDs at once?
      - Can I pass parameters when executing a script?
      instructions:
      - text: Run script {scriptName} on JPDs {jpd_ids}.
        slots:
          scriptName: path.scriptName
          jpd_ids: requestBody.jpd_ids
      - text: Execute {scriptName} on {jpd_ids} with parameters {parameters}.
        slots:
          scriptName: path.scriptName
          jpd_ids: requestBody.jpd_ids
          parameters: requestBody.parameters
      method: generated
      generated: '2026-10-01'