JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Xray REST Summary API

3 actions 3 updates phrasing extends openapi/jfrog-summary-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['/v1/summary/artifact'].post
$.paths['/v1/summary/build'].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 Summary API
  version: 1.0.0
extends: openapi/jfrog-summary-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['/v1/summary/artifact'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an artifact security and license summary
      effect: read
      questions:
      - What security issues and licenses affect these artifacts?
      - Can I get a vulnerability summary for several artifact paths at once?
      instructions:
      - text: Get the security and license summary for artifacts {paths}.
        slots:
          paths: requestBody.paths
      - text: Summarize issues and licenses for artifact paths {paths}.
        slots:
          paths: requestBody.paths
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/summary/build'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a build's security summary
      effect: read
      questions:
      - What security issues were found in a specific build?
      - Can I see a vulnerability summary for one build number?
      instructions:
      - text: Get the security summary for build {build_name} number {build_number}.
        slots:
          build_name: requestBody.build_name
          build_number: requestBody.build_number
      - text: 'Summarize security issues in build {build_name} #{build_number}.'
        slots:
          build_name: requestBody.build_name
          build_number: requestBody.build_number
      method: generated
      generated: '2026-10-01'