JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jfrog Policies API

11 actions 11 updates phrasing extends openapi/jfrog-policies-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 11

$.info
$.paths['/v1/policies'].get
$.paths['/v1/policies'].post
$.paths['/v1/policies/{policyName}'].get
$.paths['/v1/policies/{policyName}'].put
$.paths['/v1/policies/{policyName}'].delete
$.paths['/v2/policies'].get
$.paths['/v2/policies'].post
$.paths['/v2/policies/{policyName}'].get
$.paths['/v2/policies/{policyName}'].put
$.paths['/v2/policies/{policyName}'].delete

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 Policies API
  version: 1.0.0
extends: openapi/jfrog-policies-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: 10
- target: $.paths['/v1/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List curation policies
      effect: read
      questions:
      - Which curation policies are blocking or allowing packages right now?
      - Can I see all package curation policies in one list?
      instructions:
      - text: List all curation policies.
      - text: Show me every curation policy that governs which packages get in.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a curation policy
      effect: write
      questions:
      - How do I block certain packages from entering my repositories with JFrog Curation?
      - Can a curation policy apply only to specific repositories or package types?
      instructions:
      - text: Create curation policy {policy_name} of type {policy_type}.
        slots:
          policy_name: requestBody.policy_name
          policy_type: requestBody.policy_type
      - text: Create curation policy {policy_name} of type {policy_type} for repositories {repositories}.
        slots:
          policy_name: requestBody.policy_name
          policy_type: requestBody.policy_type
          repositories: requestBody.repositories
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/policies/{policyName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a curation policy
      effect: read
      questions:
      - What conditions and actions does a given curation policy use?
      - Can I check whether a curation policy is enabled?
      instructions:
      - text: Get curation policy {policyName}.
        slots:
          policyName: path.policyName
      - text: Show me the conditions and actions of curation policy {policyName}.
        slots:
          policyName: path.policyName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/policies/{policyName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a curation policy
      effect: write
      questions:
      - Can I disable a curation policy without deleting it?
      - How do I change which package types a curation policy covers?
      instructions:
      - text: Disable curation policy {policyName} by setting enabled to {enabled}.
        slots:
          policyName: path.policyName
          enabled: requestBody.enabled
      - text: Update curation policy {policyName} to cover package types {package_types}.
        slots:
          policyName: path.policyName
          package_types: requestBody.package_types
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/policies/{policyName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a curation policy
      effect: destructive
      questions:
      - Can I delete a curation policy I no longer need?
      - What is required to remove a package curation policy?
      instructions:
      - text: Delete curation policy {policyName}.
        slots:
          policyName: path.policyName
      - text: Remove the package curation policy named {policyName}.
        slots:
          policyName: path.policyName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List security and license policies
      effect: read
      questions:
      - Which security and license compliance policies are defined for scanning?
      - Can I see all of my vulnerability and license policies together?
      instructions:
      - text: List all security and license policies.
      - text: Show me every compliance policy used for security and license checks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a security or license policy
      effect: write
      questions:
      - How do I create a policy that flags vulnerable components or banned licenses?
      - Can one compliance policy hold several rules?
      instructions:
      - text: Create {type} policy {name} with rules {rules}.
        slots:
          type: requestBody.type
          name: requestBody.name
          rules: requestBody.rules
      - text: Create a license compliance policy named {name} with type {type} and rules {rules}.
        slots:
          name: requestBody.name
          type: requestBody.type
          rules: requestBody.rules
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/policies/{policyName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security or license policy
      effect: read
      questions:
      - What rules are in a given security or license policy?
      - Can I check whether a compliance policy is a security or license type?
      instructions:
      - text: Get security/license policy {policyName}.
        slots:
          policyName: path.policyName
      - text: Show me the rules of compliance policy {policyName}.
        slots:
          policyName: path.policyName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/policies/{policyName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a security or license policy
      effect: write
      questions:
      - How do I change the rules in an existing security policy?
      - Can I update a license policy's description and rules together?
      instructions:
      - text: Replace the rules of security/license policy {policyName} with {rules}.
        slots:
          policyName: path.policyName
          rules: requestBody.rules
      - text: Update compliance policy {policyName} with description {description}.
        slots:
          policyName: path.policyName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/policies/{policyName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a security or license policy
      effect: destructive
      questions:
      - Can I remove a security or license policy I no longer enforce?
      - What happens when I delete a compliance policy by name?
      instructions:
      - text: Delete security/license policy {policyName}.
        slots:
          policyName: path.policyName
      - text: Remove the compliance policy {policyName}.
        slots:
          policyName: path.policyName
      method: generated
      generated: '2026-10-01'