# 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 Replica API
  version: 1.0.0
extends: openapi/microsoft-azure-replica-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: 10
- target: $.paths['/Partitions/{partitionId}/$/GetReplicas'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partition's replicas
      effect: read
      questions:
      - What replicas does this Service Fabric partition have and on which nodes?
      - How can I see the role and status of every replica in a partition?
      instructions:
      - text: List the replicas of partition {partition}.
        slots:
          partition: path.partitionId
      - text: Show replica roles and nodes for partition {partition}.
        slots:
          partition: path.partitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Partitions/{partitionId}/$/GetReplicas/{replicaId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one replica
      effect: read
      questions:
      - What role and node is a specific replica on?
      - Can I look up a single replica's uptime and status?
      instructions:
      - text: Get replica {replica} of partition {partition}.
        slots:
          replica: path.replicaId
          partition: path.partitionId
      - text: Show the status and uptime of replica {replica} in partition {partition}.
        slots:
          replica: path.replicaId
          partition: path.partitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a replica's health
      effect: read
      questions:
      - Is a specific replica healthy right now?
      - Can I filter a replica's health events by state?
      instructions:
      - text: Get the health of replica {replica} in partition {partition}.
        slots:
          replica: path.replicaId
          partition: path.partitionId
      - text: Show replica {replica} health events filtered by {filter} in partition {partition}.
        slots:
          replica: path.replicaId
          filter: query.EventsHealthStateFilter
          partition: path.partitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate replica health with a custom policy
      effect: read
      questions:
      - Can I check a replica's health against my own application health policy?
      - How do I override health policies when evaluating one replica?
      instructions:
      - text: Evaluate replica {replica} in partition {partition} using policy {policy}.
        slots:
          replica: path.replicaId
          partition: path.partitionId
          policy: body.ApplicationHealthPolicy
      - text: Check replica {replica} health in partition {partition} with a custom health policy.
        slots:
          replica: path.replicaId
          partition: path.partitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a health event on a replica
      effect: write
      questions:
      - How do I send a custom health report for a Service Fabric replica?
      - Do I need to say whether the replica is stateful or stateless when reporting health?
      instructions:
      - text: Report health {report} on {kind} replica {replica} of partition {partition}.
        slots:
          report: body.HealthInformation
          kind: query.ServiceKind
          replica: path.replicaId
          partition: path.partitionId
      - text: Send health report {report} for replica {replica} in partition {partition} immediately.
        slots:
          report: body.HealthInformation
          replica: path.replicaId
          partition: path.partitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas'].get
  update:
    x-apievangelist-phrasing:
      intent: List replicas an application has on a node
      effect: read
      questions:
      - Which replicas of my application are deployed on a given node?
      - Can I narrow a node's deployed replicas to one partition or service manifest?
      instructions:
      - text: List replicas of application {app} deployed on node {node}.
        slots:
          app: path.applicationId
          node: path.nodeName
      - text: Show replicas of {app} on node {node} for partition {pid}.
        slots:
          app: path.applicationId
          node: path.nodeName
          pid: query.PartitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detail of a replica deployed on a node
      effect: read
      questions:
      - What operation is a specific deployed replica currently running on its node?
      - Can I see the reported load of one deployed replica?
      instructions:
      - text: Get deployed detail of replica {replica} in partition {partition} on node {node}.
        slots:
          replica: path.replicaId
          partition: path.partitionId
          node: path.nodeName
      - text: Show current service operation of replica {replica} on node {node}, partition {partition}.
        slots:
          replica: path.replicaId
          node: path.nodeName
          partition: path.partitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas'].get
  update:
    x-apievangelist-phrasing:
      intent: Get deployed replica detail by partition on a node
      effect: read
      questions:
      - What is the deployed replica of a partition doing on a given node?
      - Can I get deployed replica details for a partition without the replica ID?
      instructions:
      - text: Get the deployed replica details for partition {partition} on node {node}.
        slots:
          partition: path.partitionId
          node: path.nodeName
      - text: Show what partition {partition}'s replica on node {node} is doing.
        slots:
          partition: path.partitionId
          node: path.nodeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a replica on a node
      effect: destructive
      questions:
      - How do I restart a misbehaving persisted replica on a node?
      - Are there safety checks when restarting a replica?
      instructions:
      - text: Restart replica {replica} of partition {partition} on node {node}.
        slots:
          replica: path.replicaId
          partition: path.partitionId
          node: path.nodeName
      - text: Bounce the replica {replica} running on node {node} in partition {partition}.
        slots:
          replica: path.replicaId
          node: path.nodeName
          partition: path.partitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a replica to simulate failure
      effect: destructive
      questions:
      - How do I simulate a replica failure by removing it from the cluster?
      - Can I force-remove a replica without a graceful close?
      instructions:
      - text: Remove replica {replica} of partition {partition} from node {node}.
        slots:
          replica: path.replicaId
          partition: path.partitionId
          node: path.nodeName
      - text: Force-remove replica {replica} on node {node} in partition {partition}, force={force}.
        slots:
          replica: path.replicaId
          node: path.nodeName
          partition: path.partitionId
          force: query.ForceRemove
      method: generated
      generated: '2026-09-26'