JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog ML REST Experiments API

5 actions 5 updates phrasing extends openapi/jfrog-experiments-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/experiments'].get

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

$.paths['/v1/experiments/{experimentId}'].get

$.paths['/v1/experiments/{experimentId}'].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 ML REST Experiments API
  version: 1.0.0
extends: openapi/jfrog-experiments-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/experiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List ML experiments
      effect: read
      questions:
      - Which ML experiments have been run?
      - Can I list only the experiments for one model?
      instructions:
      - text: List all ML experiments.
      - text: List experiments for model {model_id}.
        slots:
          model_id: query.model_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/experiments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ML experiment
      effect: write
      questions:
      - How do I track a new ML experiment?
      - Can I attach an experiment to a model and record its parameters?
      instructions:
      - text: Create an experiment named {name}.
        slots:
          name: requestBody.name
      - text: Create experiment {name} for model {model_id} with parameters {parameters}.
        slots:
          name: requestBody.name
          model_id: requestBody.model_id
          parameters: requestBody.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/experiments/{experimentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ML experiment
      effect: read
      questions:
      - What parameters were used in a given experiment?
      - Can I look up one experiment by its ID?
      instructions:
      - text: Get experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Show me the details of experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/experiments/{experimentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ML experiment
      effect: destructive
      questions:
      - Can I delete an experiment I no longer need?
      - What is needed to remove an ML experiment?
      instructions:
      - text: Delete experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Remove the experiment with ID {experimentId}.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-10-01'