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

# 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 — System System Service API
  version: 1.0.0
extends: openapi/akuity-systemservice-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: 14
- target: $.paths['/api/v1/announcement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current platform announcement
      effect: read
      questions:
      - Is there a current announcement banner on the Akuity Platform?
      - What notice is the platform showing users right now?
      instructions:
      - text: Show me the current platform announcement.
      - text: Check whether there is an active system announcement.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/agent/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current cluster agent version
      effect: read
      questions:
      - What version of the cluster agent is the platform currently shipping?
      - Which agent release would a newly connected cluster get today?
      instructions:
      - text: Tell me the current agent version.
      - text: Look up the agent release the platform installs by default.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/agent/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available cluster agent versions
      effect: read
      questions:
      - Which cluster agent versions can I choose from?
      - What older agent releases are still offered for pinning?
      instructions:
      - text: List every available agent version.
      - text: Enumerate the agent releases I could pin a cluster to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/cd/agent-size-spec'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Argo CD agent size specifications
      effect: read
      questions:
      - What CPU and memory do the different Argo CD agent sizes use?
      - Which size presets exist for an Argo CD cluster agent?
      instructions:
      - text: Show the Argo CD agent size spec.
      - text: Compare the resource presets for Argo CD agent sizes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/cd/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available Argo CD extensions
      effect: read
      questions:
      - Which Argo CD UI extensions can I enable on a managed instance?
      - What extensions does the platform offer for Argo CD?
      instructions:
      - text: List the Argo CD extensions available on the platform.
      - text: Show which extensions I can install into Argo CD.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/cd/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported Argo CD versions
      effect: read
      questions:
      - Which Argo CD versions can a managed instance run?
      - Is the latest Argo CD release supported yet?
      instructions:
      - text: List the supported Argo CD versions.
      - text: Show every Argo CD release I can pick for an instance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/email/valid-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events that can trigger email notifications
      effect: read
      questions:
      - Which platform events can send me email notifications?
      - What event types are valid for email alert subscriptions?
      instructions:
      - text: List the valid email notification events.
      - text: Show which events I can subscribe to by email.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/image-updater/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported Argo CD Image Updater versions
      effect: read
      questions:
      - Which Argo CD Image Updater versions are available?
      - Can I choose a specific Image Updater release for my instance?
      instructions:
      - text: List the supported Image Updater versions.
      - text: Show every Argo CD Image Updater release on offer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/kargo/agent-size-spec'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Kargo agent size specifications
      effect: read
      questions:
      - What resource sizes are available for a Kargo agent?
      - How much CPU and memory does each Kargo agent size preset get?
      instructions:
      - text: Show the Kargo agent size spec.
      - text: Compare the Kargo agent sizing presets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/kargo/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported Kargo versions
      effect: read
      questions:
      - Which Kargo versions can I run on a managed instance?
      - What is the newest Kargo release the platform supports?
      instructions:
      - text: List the supported Kargo versions.
      - text: Show every Kargo release available for new instances.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get platform system settings
      effect: read
      questions:
      - What system-wide settings is the Akuity Platform configured with?
      - Where can I read the platform's global settings?
      instructions:
      - text: Show the platform system settings.
      - text: Fetch the global configuration of the platform.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check platform health status
      effect: read
      questions:
      - Is the platform healthy right now?
      - How can I check whether the service is up before calling other endpoints?
      instructions:
      - text: Check the platform status.
      - text: Tell me if the system is healthy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the platform's own version
      effect: read
      questions:
      - What version of the platform server am I talking to?
      - Which build of the platform API is deployed?
      instructions:
      - text: Show the platform server version.
      - text: Report which platform build is running.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/system/webhook/valid-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events that can trigger webhooks
      effect: read
      questions:
      - Which events can I send to a webhook?
      - What event types are valid when configuring a webhook subscription?
      instructions:
      - text: List the valid webhook events.
      - text: Show which platform events a webhook can subscribe to.
      method: generated
      generated: '2026-09-26'