JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Xray REST Watches API

6 actions 6 updates phrasing extends openapi/jfrog-watches-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['/v2/watches'].get

$.paths['/v2/watches'].post

$.paths['/v2/watches/{watchName}'].get

$.paths['/v2/watches/{watchName}'].put

$.paths['/v2/watches/{watchName}'].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 Xray REST Watches API
  version: 1.0.0
extends: openapi/jfrog-watches-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['/v2/watches'].get
  update:
    x-apievangelist-phrasing:
      intent: List watches
      effect: read
      questions:
      - Which watches are monitoring my artifacts for policy violations?
      - Can I see all configured Xray watches?
      instructions:
      - text: List all watches.
      - text: Show me every watch that monitors my resources.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/watches'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a watch
      effect: write
      questions:
      - How do I start monitoring repositories or builds against my security policies?
      - Can a new watch apply several policies at once?
      instructions:
      - text: Create a watch with general data {general_data}, resources {project_resources} and policies {assigned_policies}.
        slots:
          general_data: requestBody.general_data
          project_resources: requestBody.project_resources
          assigned_policies: requestBody.assigned_policies
      - text: Set up a new watch over {project_resources} enforcing {assigned_policies}, defined by {general_data}.
        slots:
          project_resources: requestBody.project_resources
          assigned_policies: requestBody.assigned_policies
          general_data: requestBody.general_data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/watches/{watchName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a watch
      effect: read
      questions:
      - What resources and policies does a given watch cover?
      - Can I view one watch's configuration?
      instructions:
      - text: Get watch {watchName}.
        slots:
          watchName: path.watchName
      - text: Show me which policies watch {watchName} applies.
        slots:
          watchName: path.watchName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/watches/{watchName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a watch
      effect: write
      questions:
      - How do I add more repositories to an existing watch?
      - Can I change which policies a watch enforces?
      instructions:
      - text: Update watch {watchName} to cover {project_resources}.
        slots:
          watchName: path.watchName
          project_resources: requestBody.project_resources
      - text: Change watch {watchName} to enforce {assigned_policies} with general data {general_data} and resources {project_resources}.
        slots:
          watchName: path.watchName
          assigned_policies: requestBody.assigned_policies
          general_data: requestBody.general_data
          project_resources: requestBody.project_resources
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/watches/{watchName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a watch
      effect: destructive
      questions:
      - Can I stop monitoring by removing a watch?
      - What do I need to delete a watch?
      instructions:
      - text: Delete watch {watchName}.
        slots:
          watchName: path.watchName
      - text: Remove the watch named {watchName}.
        slots:
          watchName: path.watchName
      method: generated
      generated: '2026-10-01'