JFrog · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Jfrog Users API
11 actions
11 updates
phrasing
extends
openapi/jfrog-users-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/users'].get
$.paths['/api/v2/users'].post
$.paths['/api/v2/users/{username}'].get
$.paths['/api/v2/users/{username}'].delete
$.paths['/api/v2/users/{username}'].patch
$.paths['/access/api/v2/users'].get
$.paths['/access/api/v2/users'].post
$.paths['/access/api/v2/users/{username}'].get
$.paths['/access/api/v2/users/{username}'].delete
$.paths['/access/api/v2/users/{username}'].patch
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 Users API
version: 1.0.0
extends: openapi/jfrog-users-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/users'].get
update:
x-apievangelist-phrasing:
intent: List platform users with status filter
effect: read
questions:
- Which platform users are currently disabled?
- Can I page through users with a limit and offset?
instructions:
- text: List platform users with status {status}.
slots:
status: query.status
- text: Show {limit} users starting at offset {offset} from /api/v2/users.
slots:
limit: query.limit
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/users'].post
update:
x-apievangelist-phrasing:
intent: Create a user via /api/v2/users
effect: write
questions:
- How do I create a user and block their UI access at the same time?
- Can I add a new user to groups when creating them through /api/v2/users?
instructions:
- text: Create user {username} via /api/v2 with email {email} and password {password}.
slots:
username: requestBody.username
email: requestBody.email
password: requestBody.password
- text: Add API-only user {username}, email {email}, password {password}, with UI access disabled {disable_ui_access}.
slots:
username: requestBody.username
email: requestBody.email
password: requestBody.password
disable_ui_access: requestBody.disable_ui_access
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/users/{username}'].get
update:
x-apievangelist-phrasing:
intent: Get a user via /api/v2/users
effect: read
questions:
- How do I fetch a user's record from the /api/v2/users endpoint?
- What status and groups does /api/v2 report for a user?
instructions:
- text: Get user {username} from /api/v2/users.
slots:
username: path.username
- text: Show the /api/v2 record for {username}.
slots:
username: path.username
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/users/{username}'].delete
update:
x-apievangelist-phrasing:
intent: Permanently delete a user via /api/v2
effect: destructive
questions:
- Is deleting a user through /api/v2/users permanent?
- How do I permanently remove a user with the /api/v2 path?
instructions:
- text: Permanently delete user {username} via /api/v2.
slots:
username: path.username
- text: Remove {username} for good using /api/v2/users.
slots:
username: path.username
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/users/{username}'].patch
update:
x-apievangelist-phrasing:
intent: Update or disable a user via /api/v2
effect: write
questions:
- How do I disable a user account without deleting it?
- Can I change only a user's email and leave everything else alone?
instructions:
- text: Set user {username} status to {status}.
slots:
username: path.username
status: requestBody.status
- text: Change {username}'s email to {email} via /api/v2.
slots:
username: path.username
email: requestBody.email
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/users'].get
update:
x-apievangelist-phrasing:
intent: List users via the Access service
effect: read
questions:
- How do I list all users through the /access/api/v2 endpoint?
- What users does the Access service path return?
instructions:
- text: List all users from /access/api/v2/users.
- text: Show every user known to the Access service path.
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/users'].post
update:
x-apievangelist-phrasing:
intent: Create a user via the Access service
effect: write
questions:
- How do I create a user through the /access/api/v2 path?
- Can I make a new user an admin when creating them under /access?
instructions:
- text: Create user {username} under /access with email {email} and password {password}.
slots:
username: requestBody.username
email: requestBody.email
password: requestBody.password
- text: Add admin user {username} via the Access path, email {email}, password {password}, admin {admin}.
slots:
username: requestBody.username
email: requestBody.email
password: requestBody.password
admin: requestBody.admin
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/users/{username}'].get
update:
x-apievangelist-phrasing:
intent: Get a user via the Access service
effect: read
questions:
- How do I look up a user through the /access/api/v2 path?
- What details does the Access service path give for a username?
instructions:
- text: Get user {username} from /access/api/v2.
slots:
username: path.username
- text: Look up {username} through the Access service path.
slots:
username: path.username
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/users/{username}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a user via the Access service
effect: destructive
questions:
- How do I delete a user using the /access path?
- Can I remove a user through the Access service endpoint?
instructions:
- text: Delete user {username} under /access/api/v2.
slots:
username: path.username
- text: Remove {username} through the Access service path.
slots:
username: path.username
method: generated
generated: '2026-10-01'
- target: $.paths['/access/api/v2/users/{username}'].patch
update:
x-apievangelist-phrasing:
intent: Update a user via the Access service
effect: write
questions:
- How do I change a user's groups through the /access path?
- Can I reset a user's password with the Access service update?
instructions:
- text: Update {username} under /access to belong to groups {groups}.
slots:
username: path.username
groups: requestBody.groups
- text: Reset {username}'s password to {password} via the Access path.
slots:
username: path.username
password: requestBody.password
method: generated
generated: '2026-10-01'