# 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 Models API
  version: 1.0.0
extends: openapi/jfrog-models-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['/v1/models'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered ML models
      effect: read
      questions:
      - Which ML models are registered in the model registry?
      - Can I page through registered models with a limit and offset?
      instructions:
      - text: List all registered ML models.
      - text: List {limit} models starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an ML model
      effect: write
      questions:
      - How do I register a new machine learning model in the registry?
      - Can I record a model's framework and task type when registering it?
      instructions:
      - text: Register a model named {name}.
        slots:
          name: requestBody.name
      - text: Register model {name} built with {framework} for {task_type}.
        slots:
          name: requestBody.name
          framework: requestBody.framework
          task_type: requestBody.task_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models/{modelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ML model
      effect: read
      questions:
      - What metadata is stored for a registered model?
      - Can I look up one model by its ID?
      instructions:
      - text: Get model {modelId}.
        slots:
          modelId: path.modelId
      - text: Show me the registry details for model {modelId}.
        slots:
          modelId: path.modelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models/{modelId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an ML model's metadata
      effect: write
      questions:
      - Can I change a registered model's tags or description?
      - How do I update the framework recorded for a model?
      instructions:
      - text: Update model {modelId} with tags {tags}.
        slots:
          modelId: path.modelId
          tags: requestBody.tags
      - text: Rename model {modelId} to {name}.
        slots:
          modelId: path.modelId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/models/{modelId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a model and all its versions
      effect: destructive
      questions:
      - What happens to a model's versions when I delete the model?
      - Can I remove a model from the registry entirely?
      instructions:
      - text: Delete model {modelId} and all of its versions.
        slots:
          modelId: path.modelId
      - text: Remove model {modelId} from the registry.
        slots:
          modelId: path.modelId
      method: generated
      generated: '2026-10-01'