JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog ML REST Model Versions API

5 actions 5 updates phrasing extends openapi/jfrog-model-versions-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/models/{modelId}/versions'].get
$.paths['/v1/models/{modelId}/versions'].post
$.paths['/v1/models/{modelId}/versions/{versionId}'].get
$.paths['/v1/models/{modelId}/versions/{versionId}'].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 Model Versions API
  version: 1.0.0
extends: openapi/jfrog-model-versions-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/models/{modelId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a model's versions
      effect: read
      questions:
      - Which versions exist for a given model?
      - Can I see every version of a model I registered?
      instructions:
      - text: List all versions of model {modelId}.
        slots:
          modelId: path.modelId
      - text: Show me the version history of model {modelId}.
        slots:
          modelId: path.modelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models/{modelId}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a model version
      effect: write
      questions:
      - How do I add a new version to a registered model?
      - Can I record metrics and an artifact path on a new model version?
      instructions:
      - text: Create version {version} of model {modelId}.
        slots:
          version: requestBody.version
          modelId: path.modelId
      - text: Add version {version} to model {modelId} with artifact path {artifact_path} and metrics {metrics}.
        slots:
          version: requestBody.version
          modelId: path.modelId
          artifact_path: requestBody.artifact_path
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models/{modelId}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a model version
      effect: read
      questions:
      - What metrics and status does one model version have?
      - Can I fetch a single version of a model?
      instructions:
      - text: Get version {versionId} of model {modelId}.
        slots:
          versionId: path.versionId
          modelId: path.modelId
      - text: Show me the metrics of model {modelId} version {versionId}.
        slots:
          modelId: path.modelId
          versionId: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models/{modelId}/versions/{versionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a model version
      effect: destructive
      questions:
      - Can I delete just one version of a model and keep the rest?
      - How do I remove a bad model version?
      instructions:
      - text: Delete version {versionId} of model {modelId}.
        slots:
          versionId: path.versionId
          modelId: path.modelId
      - text: Remove model {modelId}'s version {versionId}.
        slots:
          modelId: path.modelId
          versionId: path.versionId
      method: generated
      generated: '2026-10-01'