Akuity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akuity Platform API — Extension Extension Service API

7 actions 7 updates phrasing extends openapi/akuity-extensionservice-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Akuity's API. It is a proposal applied on top of the contract, not a document Akuity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/ext-api/v1/argocd/extensions/audit-records'].post
$.paths['/ext-api/v1/argocd/extensions/sync-operations-events'].post
$.paths['/ext-api/v1/argocd/extensions/sync-operations-stats'].post
$.paths['/ext-api/v1/kargo/extensions/audit-records'].post
$.paths['/ext-api/v1/kargo/extensions/logs/{project_name}/{analysis_run}/{shard}/{job_namespace}/{job_name}/{container_name}'].get
$.paths['/ext-api/v1/kargo/extensions/settings'].get

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 Akuity Platform API — Extension Extension Service API
  version: 1.0.0
extends: openapi/akuity-extensionservice-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/ext-api/v1/argocd/extensions/audit-records'].post
  update:
    x-apievangelist-phrasing:
      intent: List audit records for an Argo CD application
      effect: read
      questions:
      - Who changed my Argo CD application and when?
      - Can I filter an application's audit trail inside the Argo CD extension?
      instructions:
      - text: List the audit records for my Argo CD application.
      - text: Show application audit entries matching filters {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ext-api/v1/argocd/extensions/sync-operations-events'].post
  update:
    x-apievangelist-phrasing:
      intent: Get sync operation events for an application
      effect: read
      questions:
      - What sync operations has my Argo CD application gone through?
      - Can I page through an application's sync history with a limit and offset?
      instructions:
      - text: Show the sync operation events for my application.
      - text: Fetch {limit} application sync events starting at offset {offset}.
        slots:
          limit: requestBody.limit
          offset: requestBody.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ext-api/v1/argocd/extensions/sync-operations-stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get sync operation statistics for an application
      effect: read
      questions:
      - How many syncs does my Argo CD application run per day?
      - Can application sync counts be grouped by a field such as result?
      instructions:
      - text: Chart my application's sync operation stats per {interval}.
        slots:
          interval: requestBody.interval
      - text: Count application syncs grouped by {group_by}.
        slots:
          group_by: requestBody.groupByField
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ext-api/v1/kargo/extensions/audit-records'].post
  update:
    x-apievangelist-phrasing:
      intent: List audit records for a Kargo project
      effect: read
      questions:
      - Who made changes in my Kargo project?
      - Can I read a Kargo project's audit trail with filters?
      instructions:
      - text: List audit records for Kargo project {project}.
        slots:
          project: requestBody.projectName
      - text: Show project {project} audit entries matching {filters}.
        slots:
          project: requestBody.projectName
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ext-api/v1/kargo/extensions/logs/{project_name}/{analysis_run}/{shard}/{job_namespace}/{job_name}/{container_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs from a Kargo analysis run job
      effect: read
      questions:
      - Why did my Kargo verification analysis fail?
      - Where can I read the container logs of a Kargo analysis job?
      instructions:
      - text: Show logs for container {container_name} of job {job_name} in namespace {job_namespace}, analysis run {analysis_run}, project {project_name}, shard {shard}.
        slots:
          container_name: path.container_name
          job_name: path.job_name
          job_namespace: path.job_namespace
          analysis_run: path.analysis_run
          project_name: path.project_name
          shard: path.shard
      - text: Fetch analysis run {analysis_run} output in {project_name} from shard {shard}, {job_namespace}/{job_name}/{container_name}.
        slots:
          analysis_run: path.analysis_run
          project_name: path.project_name
          shard: path.shard
          job_namespace: path.job_namespace
          job_name: path.job_name
          container_name: path.container_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ext-api/v1/kargo/extensions/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Kargo extension settings
      effect: read
      questions:
      - How is the Kargo UI extension configured?
      - Which settings does the Kargo extension expose?
      instructions:
      - text: Show the Kargo extension settings.
      - text: Read the current configuration of the Kargo extension.
      method: generated
      generated: '2026-09-26'