JFrog · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Jfrog Permissions API
11 actions
11 updates
phrasing
extends
openapi/jfrog-permissions-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/api/v2/permissions'].get
$.paths['/api/v2/permissions'].post
$.paths['/api/v2/permissions/{permissionName}'].get
$.paths['/api/v2/permissions/{permissionName}'].put
$.paths['/api/v2/permissions/{permissionName}'].delete
$.paths['/access/api/v2/permissions'].get
$.paths['/access/api/v2/permissions'].post
$.paths['/access/api/v2/permissions/{permissionName}'].get
$.paths['/access/api/v2/permissions/{permissionName}'].put
$.paths['/access/api/v2/permissions/{permissionName}'].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 Permissions API
version: 1.0.0
extends: openapi/jfrog-permissions-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['/api/v2/permissions'].get
update:
x-apievangelist-phrasing:
intent: List permission targets (/api/v2)
effect: read
questions:
- Which permission targets are configured across the platform via /api/v2/permissions?
- Can I list repo, build and release bundle permission targets in one call?
instructions:
- text: List permission targets from the /api/v2/permissions endpoint.
- text: Show all platform permission targets via /api/v2.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/permissions'].post
update:
x-apievangelist-phrasing:
intent: Create a permission target (/api/v2)
effect: write
questions:
- How do I create a permission target covering repositories, builds and release bundles?
- Can a new /api/v2 permission target include resource rules from the start?
instructions:
- text: Create permission target {name} via /api/v2 with resources {resources}.
slots:
name: requestBody.name
resources: requestBody.resources
- text: Add a new /api/v2 permission target called {name}.
slots:
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/permissions/{permissionName}'].get
update:
x-apievangelist-phrasing:
intent: Get a permission target (/api/v2)
effect: read
questions:
- What is the full configuration of a permission target under /api/v2?
- How do I see the access rules of one target from the /api/v2 endpoint?
instructions:
- text: Show /api/v2 permission target {permissionName}.
slots:
permissionName: path.permissionName
- text: Get the full /api/v2 config of permission {permissionName}.
slots:
permissionName: path.permissionName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/permissions/{permissionName}'].put
update:
x-apievangelist-phrasing:
intent: Replace a permission target (/api/v2)
effect: write
questions:
- Does the /api/v2 permission update replace the whole configuration?
- How do I rewrite the resources of an existing /api/v2 permission target?
instructions:
- text: Replace /api/v2 permission target {permissionName} with resources {resources}.
slots:
permissionName: path.permissionName
resources: requestBody.resources
- text: Overwrite /api/v2 permission {permissionName}, keeping the name {name}.
slots:
permissionName: path.permissionName
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/permissions/{permissionName}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a permission target (/api/v2)
effect: destructive
questions:
- What happens to access rules when I delete a target via /api/v2/permissions?
- How do I remove a permission target using the /api/v2 path?
instructions:
- text: Delete /api/v2 permission target {permissionName}.
slots:
permissionName: path.permissionName
- text: Remove permission target {permissionName} and its rules via /api/v2.
slots:
permissionName: path.permissionName
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/permissions'].get
update:
x-apievangelist-phrasing:
intent: List permissions in the Access service
effect: read
questions:
- Which permission configurations does the Access service hold?
- Can I list permissions through the /access/api/v2 endpoint?
instructions:
- text: List all permissions from the Access service.
- text: Show every permission configuration under /access/api/v2.
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/permissions'].post
update:
x-apievangelist-phrasing:
intent: Create a permission in the Access service
effect: write
questions:
- How do I create a permission configuration through the Access service path?
- Can I pass resources when creating a permission under /access?
instructions:
- text: Create Access service permission {name} with resources {resources}.
slots:
name: requestBody.name
resources: requestBody.resources
- text: Add permission {name} through /access/api/v2.
slots:
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/permissions/{permissionName}'].get
update:
x-apievangelist-phrasing:
intent: Get a permission from the Access service
effect: read
questions:
- How do I read one permission's details from the Access service?
- What does /access/api/v2 return for a single permission?
instructions:
- text: Show Access service permission {permissionName}.
slots:
permissionName: path.permissionName
- text: Get permission {permissionName} via /access/api/v2.
slots:
permissionName: path.permissionName
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/permissions/{permissionName}'].put
update:
x-apievangelist-phrasing:
intent: Update a permission in the Access service
effect: write
questions:
- How do I change a permission's resources through the Access service?
- Can I update an /access permission configuration in place?
instructions:
- text: Update Access service permission {permissionName} with resources {resources}.
slots:
permissionName: path.permissionName
resources: requestBody.resources
- text: Change /access permission {permissionName}, setting its name to {name}.
slots:
permissionName: path.permissionName
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/permissions/{permissionName}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a permission in the Access service
effect: destructive
questions:
- How do I delete a permission through the /access path?
- Can I remove an Access service permission configuration by name?
instructions:
- text: Delete Access service permission {permissionName}.
slots:
permissionName: path.permissionName
- text: Remove permission {permissionName} via /access/api/v2.
slots:
permissionName: path.permissionName
method: generated
generated: '2026-10-01'