JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Xray REST Scanning API

3 actions 3 updates phrasing extends openapi/jfrog-scanning-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 3

$.info
$.paths['/v2/ci/scan'].post
$.paths['/v1/scanArtifact'].post

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 Xray REST Scanning API
  version: 1.0.0
extends: openapi/jfrog-scanning-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: 2
- target: $.paths['/v2/ci/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan a build on demand
      effect: write
      questions:
      - How do I trigger a security scan of a CI build?
      - Can I force a rescan of a build that was already scanned?
      instructions:
      - text: Scan build {buildName} number {buildNumber}.
        slots:
          buildName: requestBody.buildName
          buildNumber: requestBody.buildNumber
      - text: 'Rescan build {buildName} #{buildNumber} with rescan set to {rescan}.'
        slots:
          buildName: requestBody.buildName
          buildNumber: requestBody.buildNumber
          rescan: requestBody.rescan
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/scanArtifact'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan an artifact by component ID
      effect: write
      questions:
      - How do I scan a single artifact for vulnerabilities?
      - Can I trigger a scan for a component by its ID?
      instructions:
      - text: Scan the artifact with component ID {componentID}.
        slots:
          componentID: requestBody.componentID
      - text: Trigger a vulnerability scan for component {componentID}.
        slots:
          componentID: requestBody.componentID
      method: generated
      generated: '2026-10-01'