JFrog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for JFrog Pipelines REST Integrations API

6 actions 6 updates phrasing extends openapi/jfrog-integrations-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 6

$.info

$.paths['/v1/integrations'].get

$.paths['/v1/integrations'].post

$.paths['/v1/integrations/{integrationId}'].get

$.paths['/v1/integrations/{integrationId}'].put

$.paths['/v1/integrations/{integrationId}'].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 Pipelines REST Integrations API
  version: 1.0.0
extends: openapi/jfrog-integrations-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: 5
- target: $.paths['/v1/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List integrations
      effect: read
      questions:
      - Which external service integrations are set up in Pipelines?
      - Can I see all configured integrations?
      instructions:
      - text: List all integrations.
      - text: Show me every external service integration that is configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration
      effect: write
      questions:
      - How do I connect an external service like a Git provider as an integration?
      - Can I scope a new integration to a specific project?
      instructions:
      - text: Create integration {name} of type {masterIntegrationName}.
        slots:
          name: requestBody.name
          masterIntegrationName: requestBody.masterIntegrationName
      - text: Create integration {name} of type {masterIntegrationName} in project {projectId}.
        slots:
          name: requestBody.name
          masterIntegrationName: requestBody.masterIntegrationName
          projectId: requestBody.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/integrations/{integrationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration
      effect: read
      questions:
      - What are the settings of a particular integration?
      - Can I look up one integration by its ID?
      instructions:
      - text: Get integration {integrationId}.
        slots:
          integrationId: path.integrationId
      - text: Show me the configuration of integration {integrationId}.
        slots:
          integrationId: path.integrationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/integrations/{integrationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an integration
      effect: write
      questions:
      - How do I change the form values or credentials fields of an existing integration?
      - Can I rename an integration?
      instructions:
      - text: Rename integration {integrationId} to {name}.
        slots:
          integrationId: path.integrationId
          name: requestBody.name
      - text: Update integration {integrationId} with form values {formJSONValues}.
        slots:
          integrationId: path.integrationId
          formJSONValues: requestBody.formJSONValues
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/integrations/{integrationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration
      effect: destructive
      questions:
      - Can I delete an integration I no longer use?
      - What is needed to remove an integration?
      instructions:
      - text: Delete integration {integrationId}.
        slots:
          integrationId: path.integrationId
      - text: Remove the integration with ID {integrationId}.
        slots:
          integrationId: path.integrationId
      method: generated
      generated: '2026-10-01'