JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog ML REST Deployments API

5 actions 5 updates phrasing extends openapi/jfrog-deployments-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/deployments'].get
$.paths['/v1/deployments'].post
$.paths['/v1/deployments/{deploymentId}'].get
$.paths['/v1/deployments/{deploymentId}'].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 ML REST Deployments API
  version: 1.0.0
extends: openapi/jfrog-deployments-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/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List model deployments
      effect: read
      questions:
      - Which ML model deployments are currently serving predictions?
      - Can I see all of my model deployments?
      instructions:
      - text: List all model deployments.
      - text: Show me every deployed model that serves predictions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a model version
      effect: write
      questions:
      - How do I deploy a trained model version so it can serve predictions?
      - Can I choose how many replicas a model deployment runs?
      instructions:
      - text: Deploy version {model_version_id} of model {model_id} as {name}.
        slots:
          model_version_id: requestBody.model_version_id
          model_id: requestBody.model_id
          name: requestBody.name
      - text: Deploy model {model_id} version {model_version_id} as {name} with {replicas} replicas.
        slots:
          model_id: requestBody.model_id
          model_version_id: requestBody.model_version_id
          name: requestBody.name
          replicas: requestBody.replicas
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/deployments/{deploymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a model deployment
      effect: read
      questions:
      - What resources and replicas does a model deployment use?
      - Can I check the details of one deployment by ID?
      instructions:
      - text: Get deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      - text: Show me the details of model deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/deployments/{deploymentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a model deployment
      effect: destructive
      questions:
      - Can I take a model deployment offline?
      - How do I stop serving a deployed model?
      instructions:
      - text: Delete deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      - text: Stop serving and remove model deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-10-01'