JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jfrog Groups API

11 actions 11 updates phrasing extends openapi/jfrog-groups-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['/api/v2/groups'].get

$.paths['/api/v2/groups'].post

$.paths['/api/v2/groups/{groupName}'].get

$.paths['/api/v2/groups/{groupName}'].delete

$.paths['/api/v2/groups/{groupName}'].patch

$.paths['/access/api/v2/groups'].get

$.paths['/access/api/v2/groups'].post

$.paths['/access/api/v2/groups/{groupName}'].get

$.paths['/access/api/v2/groups/{groupName}'].delete

$.paths['/access/api/v2/groups/{groupName}'].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 Groups API
  version: 1.0.0
extends: openapi/jfrog-groups-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/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups in the Access service
      effect: read
      questions:
      - Which user groups are configured in the standalone Access service?
      - Can I list groups directly from the Access service's /api/v2 endpoint?
      instructions:
      - text: List all groups from the Access service's /api/v2 endpoint.
      - text: Show me every group configured in the standalone Access service.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group in the Access service
      effect: write
      questions:
      - How do I create a group for organizing users and permissions in the Access service?
      - Can new users auto-join a group I create in the Access service?
      instructions:
      - text: Create an Access service group named {name}.
        slots:
          name: requestBody.name
      - text: Create Access service group {name} with members {members}.
        slots:
          name: requestBody.name
          members: requestBody.members
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/groups/{groupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group and its members from Access
      effect: read
      questions:
      - Who are the members of a group in the standalone Access service?
      - Can I see a group's realm and external ID directly from the Access service?
      instructions:
      - text: Get group {groupName} and its members from the Access service.
        slots:
          groupName: path.groupName
      - text: Show me the Access service's details for group {groupName}.
        slots:
          groupName: path.groupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/groups/{groupName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group in the Access service
      effect: destructive
      questions:
      - What happens to user associations when I delete a group in the Access service?
      - Can I delete a group directly through the standalone Access service?
      instructions:
      - text: Delete Access service group {groupName} and its user associations.
        slots:
          groupName: path.groupName
      - text: Remove group {groupName} via the Access service's /api/v2 endpoint.
        slots:
          groupName: path.groupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/groups/{groupName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group in the Access service
      effect: write
      questions:
      - Can I change only a group's description in the Access service without resending everything?
      - How do I turn on auto-join for an existing group in the Access service?
      instructions:
      - text: In the Access service, change group {groupName}'s description to {description}.
        slots:
          groupName: path.groupName
          description: requestBody.description
      - text: Set auto-join to {auto_join} on Access service group {groupName}.
        slots:
          auto_join: requestBody.auto_join
          groupName: path.groupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access/api/v2/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups through the Platform route
      effect: read
      questions:
      - Which groups exist on my JFrog Platform via the /access route?
      - Can I list platform groups through the unified platform URL?
      instructions:
      - text: List all platform groups through the /access/api/v2 route.
      - text: Show me every group on the platform via the access route.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access/api/v2/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group through the Platform route
      effect: write
      questions:
      - How do I create a platform group using the /access URL?
      - Can I give a new group admin privileges through the platform route?
      instructions:
      - text: Through the platform /access route, create group {name}.
        slots:
          name: requestBody.name
      - text: Via the platform URL, create group {name} with admin privileges set to {admin_privileges}.
        slots:
          name: requestBody.name
          admin_privileges: requestBody.admin_privileges
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access/api/v2/groups/{groupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group through the Platform route
      effect: read
      questions:
      - What are a group's details when fetched through the platform /access URL?
      - Can I read one group via the unified platform route?
      instructions:
      - text: Get group {groupName} through the platform /access route.
        slots:
          groupName: path.groupName
      - text: Fetch group {groupName}'s details via the platform URL.
        slots:
          groupName: path.groupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access/api/v2/groups/{groupName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group through the Platform route
      effect: destructive
      questions:
      - Can I delete a group using the platform's /access URL?
      - What do I need to remove a group through the unified platform route?
      instructions:
      - text: Delete group {groupName} through the platform /access route.
        slots:
          groupName: path.groupName
      - text: Via the platform URL, remove the group {groupName}.
        slots:
          groupName: path.groupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access/api/v2/groups/{groupName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group through the Platform route
      effect: write
      questions:
      - How do I change a group's members using the platform /access URL?
      - Can I update a group's external ID through the platform route?
      instructions:
      - text: Through the platform /access route, set group {groupName}'s members to {members}.
        slots:
          groupName: path.groupName
          members: requestBody.members
      - text: Via the platform URL, change group {groupName}'s external ID to {external_id}.
        slots:
          groupName: path.groupName
          external_id: requestBody.external_id
      method: generated
      generated: '2026-10-01'