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.
# 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 Reports API
version: 1.0.0
extends: openapi/jfrog-reports-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: 3
- target: $.paths['/v1/report/vulnerabilities'].post
update:
x-apievangelist-phrasing:
intent: Generate a vulnerability report
effect: write
questions:
- How do I generate a vulnerability report for certain repositories or builds?
- Can I filter a vulnerability report, for example by severity?
instructions:
- text: Generate vulnerability report {name} for {resources}.
slots:
name: requestBody.name
resources: requestBody.resources
- text: Create vulnerability report {name} over {resources} with filters {filters}.
slots:
name: requestBody.name
resources: requestBody.resources
filters: requestBody.filters
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/report/{reportId}'].get
update:
x-apievangelist-phrasing:
intent: Get a report's status
effect: read
questions:
- Is my vulnerability report finished generating?
- Can I check the details of a report by its ID?
instructions:
- text: Get the status of report {reportId}.
slots:
reportId: path.reportId
- text: Check whether report {reportId} is ready.
slots:
reportId: path.reportId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/report/{reportId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a generated report
effect: destructive
questions:
- Can I delete a report I generated earlier?
- How do I clean up old generated reports?
instructions:
- text: Delete report {reportId}.
slots:
reportId: path.reportId
- text: Remove the generated report {reportId}.
slots:
reportId: path.reportId
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.