# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Service Groups API
  version: 1.0.0
extends: openapi/progress-software-service-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: 9
- target: $.paths['/api/v0/applications/delete_disconnected_services'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete disconnected services past a threshold
      effect: destructive
      questions:
      - How do I remove services that have been disconnected longer than a set number of seconds?
      - Can I purge disconnected services on demand for testing?
      instructions:
      - text: Delete services disconnected for more than {threshold_seconds} seconds.
        slots:
          threshold_seconds: requestBody.threshold_seconds
      - text: Purge all disconnected services using the default threshold.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/delete_services_by_id'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete specific services by ID
      effect: destructive
      questions:
      - How do I delete particular services from the applications view by their IDs?
      - Can I remove several services at once?
      instructions:
      - text: Delete the services with IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: Remove these services {ids} from applications.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/disconnected_services'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark services disconnected after a threshold
      effect: write
      questions:
      - How do I flag services as disconnected when they haven't reported within some seconds?
      - Can I manually trigger the disconnected-service marking with a custom threshold?
      instructions:
      - text: Mark services disconnected if silent for {threshold_seconds} seconds.
        slots:
          threshold_seconds: query.threshold_seconds
      - text: Flag stale services as disconnected using a {threshold_seconds}-second threshold.
        slots:
          threshold_seconds: query.threshold_seconds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/service-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List service groups with health
      effect: read
      questions:
      - Which service groups are running and how healthy are they?
      - Can I filter service groups by status or environment?
      instructions:
      - text: List my service groups with their health.
      - text: Show service groups matching filter {filter}, sorted by {sorting.field}.
        slots:
          filter: query.filter
          sorting.field: query.sorting.field
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/service-groups/{service_group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the services in a service group
      effect: read
      questions:
      - What services make up a particular service group?
      - Can I see the health of each service inside one service group?
      instructions:
      - text: List the services in service group {service_group_id}.
        slots:
          service_group_id: path.service_group_id
      - text: Show services in group {service_group_id} filtered by {filter}.
        slots:
          service_group_id: path.service_group_id
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/service_groups_health_counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Count service groups by health status
      effect: read
      questions:
      - How many service groups are critical, warning, ok or unknown?
      - Can I get service group health totals for a filtered subset?
      instructions:
      - text: Count my service groups by health status.
      - text: Give health counts for service groups matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List all services with health
      effect: read
      questions:
      - What is the health status of every service across all groups?
      - Can I search services and filter them by status?
      instructions:
      - text: List all services and their health.
      - text: Show services across all groups matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/services-distinct-values'].get
  update:
    x-apievangelist-phrasing:
      intent: List possible filter values for a service field
      effect: read
      questions:
      - What values can I filter services by for a given field, like environment?
      - Can I autocomplete service filter values with a wildcard fragment?
      instructions:
      - text: List distinct values for service field {field_name}.
        slots:
          field_name: query.field_name
      - text: Suggest values of {field_name} that match {query_fragment}.
        slots:
          field_name: query.field_name
          query_fragment: query.query_fragment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize service groups, services and supervisors
      effect: read
      questions:
      - How many service groups, services, deployments and supervisors do I have in total?
      - Is there an unfiltered summary count of my applications estate?
      instructions:
      - text: Show the summary counts of service groups, services, deployments and supervisors.
      - text: Give me the applications telemetry summary.
      method: generated
      generated: '2026-10-01'