# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Service Fabric Client Services API
  version: 1.0.0
extends: openapi/microsoft-azure-services-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: 9
- target: $.paths['/Services/{serviceId}/$/GetApplicationName'].get
  update:
    x-apievangelist-phrasing:
      intent: Find which application a service belongs to
      effect: read
      questions:
      - Which Service Fabric application owns a given service?
      - Can I get the parent application name from just a service ID?
      instructions:
      - text: Tell me which application service {serviceId} belongs to.
        slots:
          serviceId: path.serviceId
      - text: Look up the parent application name of Service Fabric service {serviceId}.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/Delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a Service Fabric service
      effect: destructive
      questions:
      - How do I remove a Service Fabric service from my cluster?
      - Can I force-delete a service whose replicas won't close gracefully?
      instructions:
      - text: Delete Service Fabric service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Force-remove service {serviceId} without waiting for a graceful replica shutdown ({force}).
        slots:
          serviceId: path.serviceId
          force: query.ForceRemove
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/Update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a running Service Fabric service
      effect: write
      questions:
      - Can I change the properties of a Service Fabric service while it's running?
      - Which service settings are still editable after creation?
      instructions:
      - text: Update running service {serviceId} with {update_description}.
        slots:
          serviceId: path.serviceId
          update_description: body.ServiceUpdateDescription
      - text: 'Apply this service update description to {serviceId}: {update_description}.'
        slots:
          serviceId: path.serviceId
          update_description: body.ServiceUpdateDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/GetDescription'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Service Fabric service's description
      effect: read
      questions:
      - What configuration was a Service Fabric service created with?
      - Can I read back the full description of an existing service?
      instructions:
      - text: Show the description of service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Get the partitioning and placement setup of Service Fabric service {serviceId}.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/GetHealth'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Service Fabric service's health
      effect: read
      questions:
      - Is my Service Fabric service healthy right now?
      - Can I narrow the health events of a service to just errors and warnings?
      instructions:
      - text: Check the health of service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Show health for {serviceId}, keeping only events in state {events_filter}.
        slots:
          serviceId: path.serviceId
          events_filter: query.EventsHealthStateFilter
      - text: Report service {serviceId} health with partitions filtered to {partitions_filter}.
        slots:
          serviceId: path.serviceId
          partitions_filter: query.PartitionsHealthStateFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/GetHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate service health with a custom policy
      effect: read
      questions:
      - Can I evaluate a service's health against my own application health policy?
      - How does a stricter health policy change the aggregated state of a service?
      instructions:
      - text: Evaluate the health of {serviceId} using health policy {policy}.
        slots:
          serviceId: path.serviceId
          policy: body.ApplicationHealthPolicy
      - text: Apply my custom application health policy {policy} when judging service {serviceId}.
        slots:
          policy: body.ApplicationHealthPolicy
          serviceId: path.serviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/ReportHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a health report on a service
      effect: write
      questions:
      - How do I report a custom health warning against a Service Fabric service?
      - Can a health report be sent immediately instead of batched?
      instructions:
      - text: 'Report this health information on service {serviceId}: {health_info}.'
        slots:
          serviceId: path.serviceId
          health_info: body.HealthInformation
      - text: Send health report {health_info} for {serviceId} immediately ({immediate}).
        slots:
          health_info: body.HealthInformation
          serviceId: path.serviceId
          immediate: query.Immediate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/ResolvePartition'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a service partition to its endpoints
      effect: read
      questions:
      - What endpoints are a service's replicas listening on?
      - Can I resolve the partition that owns a particular partition key?
      instructions:
      - text: Resolve service {serviceId} to its replica endpoints.
        slots:
          serviceId: path.serviceId
      - text: Find the endpoints of the {serviceId} partition for key {partition_key}.
        slots:
          serviceId: path.serviceId
          partition_key: query.PartitionKeyValue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{serviceId}/$/GetUnplacedReplicaInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Explain why service replicas are unplaced
      effect: read
      questions:
      - Why are some replicas of my service not getting placed on nodes?
      - Can I limit the unplaced replica report to one partition or just primaries?
      instructions:
      - text: Show unplaced replica information for service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Explain unplaced replicas of {serviceId} in partition {partition_id}.
        slots:
          serviceId: path.serviceId
          partition_id: query.PartitionId
      method: generated
      generated: '2026-09-26'