# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Unity Multiplay Game Server Hosting Fleets API
  version: 1.0.0
extends: openapi/unity-fleets-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: 5
- target: $.paths['/v1/projects/{projectId}/regions/{regionId}/fleets'].get
  update:
    x-apievangelist-phrasing:
      intent: List game server fleets in a region
      effect: read
      questions:
      - Which server fleets do I have running in a given region?
      - What fleets are configured for my project in this region?
      instructions:
      - text: List the fleets in region {regionId} for project {projectId}.
        slots:
          regionId: path.regionId
          projectId: path.projectId
      - text: Show every game server fleet configured in region {regionId} of project {projectId}.
        slots:
          regionId: path.regionId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/regions/{regionId}/fleets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a game server fleet
      effect: write
      questions:
      - How do I set up a new fleet of game servers in a region?
      - Can I configure scaling settings when I create a fleet?
      instructions:
      - text: Create fleet {name} in region {regionId} of project {projectId} using build configuration {buildConfiguration}.
        slots:
          name: requestBody.name
          regionId: path.regionId
          projectId: path.projectId
          buildConfiguration: requestBody.buildConfiguration
      - text: Set up a new server fleet {name} with build configuration {buildConfiguration} and scaling {scalingSettings} in region {regionId}, project {projectId}.
        slots:
          name: requestBody.name
          buildConfiguration: requestBody.buildConfiguration
          scalingSettings: requestBody.scalingSettings
          regionId: path.regionId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fleet's configuration and status
      effect: read
      questions:
      - What is the status of one of my game server fleets?
      - Can I check which build version a particular fleet is running?
      instructions:
      - text: Show fleet {fleetId} in region {regionId} of project {projectId}.
        slots:
          fleetId: path.fleetId
          regionId: path.regionId
          projectId: path.projectId
      - text: Get the status and configuration of fleet {fleetId} (project {projectId}, region {regionId}).
        slots:
          fleetId: path.fleetId
          projectId: path.projectId
          regionId: path.regionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a fleet and terminate its servers
      effect: destructive
      questions:
      - What happens to running servers when I delete a fleet?
      - Can I tear down a whole game server fleet at once?
      instructions:
      - text: Delete fleet {fleetId} in region {regionId} of project {projectId}.
        slots:
          fleetId: path.fleetId
          regionId: path.regionId
          projectId: path.projectId
      - text: Tear down fleet {fleetId} and terminate its servers in project {projectId}, region {regionId}.
        slots:
          fleetId: path.fleetId
          projectId: path.projectId
          regionId: path.regionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/regions/{regionId}/fleets/{fleetId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a fleet's scaling or build version
      effect: write
      questions:
      - Can I change the scaling settings on an existing fleet?
      - Is it possible to roll a fleet onto a new build version?
      instructions:
      - text: Update the scaling settings of fleet {fleetId} in region {regionId}, project {projectId}, to {scalingSettings}.
        slots:
          fleetId: path.fleetId
          regionId: path.regionId
          projectId: path.projectId
          scalingSettings: requestBody.scalingSettings
      - text: Switch fleet {fleetId} in project {projectId}, region {regionId}, to build configuration {buildConfiguration}.
        slots:
          fleetId: path.fleetId
          projectId: path.projectId
          regionId: path.regionId
          buildConfiguration: requestBody.buildConfiguration
      method: generated
      generated: '2026-10-01'