JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Mission Control REST JPDs API

6 actions 6 updates phrasing extends openapi/jfrog-jpds-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 6

$.info
$.paths['/v3/jpds'].get
$.paths['/v3/jpds'].post
$.paths['/v3/jpds/{jpdId}'].get
$.paths['/v3/jpds/{jpdId}'].put
$.paths['/v3/jpds/{jpdId}'].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 Mission Control REST JPDs API
  version: 1.0.0
extends: openapi/jfrog-jpds-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: 5
- target: $.paths['/v3/jpds'].get
  update:
    x-apievangelist-phrasing:
      intent: List managed platform deployments
      effect: read
      questions:
      - Which JFrog Platform Deployments does Mission Control manage?
      - Can I list all my JPDs and their locations?
      instructions:
      - text: List all managed JPDs.
      - text: Show every platform deployment in Mission Control.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/jpds'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a platform deployment to Mission Control
      effect: write
      questions:
      - How do I register a new JFrog Platform Deployment with Mission Control?
      - Can I record a location when adding a JPD?
      instructions:
      - text: Add JPD {name} at {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: Register deployment {name} at {url} located in {location}.
        slots:
          name: requestBody.name
          url: requestBody.url
          location: requestBody.location
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/jpds/{jpdId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a platform deployment
      effect: read
      questions:
      - How do I see the details of one managed JPD?
      - What URL and location are stored for a specific JPD?
      instructions:
      - text: Show JPD {jpdId}.
        slots:
          jpdId: path.jpdId
      - text: Get details for platform deployment {jpdId}.
        slots:
          jpdId: path.jpdId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/jpds/{jpdId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a platform deployment
      effect: write
      questions:
      - How do I change the URL of a JPD that Mission Control manages?
      - Can I rename an existing JPD?
      instructions:
      - text: Update JPD {jpdId} to name {name} and URL {url}.
        slots:
          jpdId: path.jpdId
          name: requestBody.name
          url: requestBody.url
      - text: Move JPD {jpdId} to location {location}, name {name}, URL {url}.
        slots:
          jpdId: path.jpdId
          location: requestBody.location
          name: requestBody.name
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/jpds/{jpdId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a platform deployment
      effect: destructive
      questions:
      - How do I stop Mission Control from managing a JPD?
      - Can I unregister a platform deployment?
      instructions:
      - text: Remove JPD {jpdId} from Mission Control.
        slots:
          jpdId: path.jpdId
      - text: Unregister platform deployment {jpdId}.
        slots:
          jpdId: path.jpdId
      method: generated
      generated: '2026-10-01'