Merge pull request #154 from buildkite/buildkite-docs-bot/graphql/b4d…

…eb7a1

Update GraphQL docs

data/graphql/schema.graphql

@@ -2144,9 +2144,9 @@ type ClusterQueue implements Node {
   hosted: Boolean!
 
   """
-  The hosted agent instance configuration for this cluster queue
+  Settings for hosted agents used for jobs in this queue
   """
-  hostedConfiguration: HostedConfigurationType
+  hostedAgentSettings: HostedAgentQueueSettings
   id: ID!
   key: String!
 
@@ -2709,6 +2709,42 @@ enum HostedAgentArchitecture {
   ARM64
 }
 
+"""
+The hosted agent instance configuration for this cluster queue
+"""
+type HostedAgentInstanceShape {
+  """
+  Specifies the architecture of the hosted agent instance, such as AMD64
+  (x86_64) or ARM64 (AArch64), used in this cluster queue.
+  """
+  architecture: HostedAgentArchitecture
+
+  """
+  Specifies the type of machine used for the hosted agent instance in this cluster queue (e.g., Linux or MacOS).
+  """
+  machineType: HostedAgentMachineType
+
+  """
+  The amount of memory (in GB) available on each hosted agent instance in this cluster queue.
+  """
+  memory: Int
+
+  """
+  Name of the instance shape
+  """
+  name: HostedAgentInstanceShapeName
+
+  """
+  The overall size classification of the hosted agent instance, combining vCPU and memory, used in this cluster queue.
+  """
+  size: HostedAgentSize
+
+  """
+  The number of CPU cores allocated to the hosted agent instance in this cluster queue.
+  """
+  vcpu: Int
+}
+
 """
 Possible instance shapes for the hosted agent instance
 """
@@ -2795,86 +2831,95 @@ enum HostedAgentInstanceShapeName {
 }
 
 """
-Possible machine types for the hosted agent instance
+Configuration options specific to Linux hosted agent instances.
 """
-enum HostedAgentMachineType {
+type HostedAgentLinuxSettings {
   """
-  Linux
+  The image reference of a custom agent base image used by the hosted agent
+  instances in this cluster queue. Note: this must be a public image, or image
+  stored within the hosted agents internal registry.
   """
-  LINUX
+  baseImageRef: String
+}
 
+"""
+Configuration options for the base image of hosted agent instances on macOS platforms.
+"""
+type HostedAgentMacOSSettingsType {
   """
-  macOS
+  The Xcode version to pre-select (via xcode-select) on macOS hosted agent instances for this cluster queue.
   """
-  MACOS
+  baseImageXcodeVersion: String
 }
 
 """
-Possible sizes for the hosted agent instance, specifying vCPU and memory allocations.
+Possible machine types for the hosted agent instance
 """
-enum HostedAgentSize {
+enum HostedAgentMachineType {
   """
-  Extra large capacity size: 12 vCPU, 28GB RAM (Linux); Not applicable for macOS.
+  Linux
   """
-  EXTRA_LARGE
+  LINUX
 
   """
-  Large capacity size: 8 vCPU, 32GB RAM (Linux); 12 vCPU, 28GB RAM (macOS).
+  macOS
   """
-  LARGE
+  MACOS
+}
 
+"""
+Platform-specific configuration for hosted agent instances.
+"""
+type HostedAgentPlatformSettings {
   """
-  Medium capacity size: 4 vCPU, 16GB RAM (Linux); 6 vCPU, 14GB RAM (macOS).
+  Configuration options specific to Linux hosted agent instances.
   """
-  MEDIUM
+  linux: HostedAgentLinuxSettings
 
   """
-  Small capacity size: 2 vCPU, 4GB RAM (Linux); 4 vCPU, 7GB RAM (macOS).
+  Configuration options specific to macOS hosted agent instances.
   """
-  SMALL
+  macos: HostedAgentMacOSSettingsType
 }
 
 """
-The hosted agent instance configuration for this cluster queue
+Platform-specific configuration for hosted agent instances.
 """
-type HostedConfigurationType {
+type HostedAgentQueueSettings {
   """
-  Specifies the architecture of the hosted agent instance, such as AMD64
-  (x86_64) or ARM64 (AArch64), used in this cluster queue.
+  The hardware specifications of the hosted agent instance, such as CPU and memory
   """
-  architecture: HostedAgentArchitecture
+  instanceShape: HostedAgentInstanceShape
 
   """
-  The Image reference of a custom agent base image used by the hosted agent
-  instances in this cluster queue. Note: this must be a public image, or image
-  stored within the hosted agents internal registry.
-  """
-  baseImageRef: String
-
+  Platform-specific configuration for Linux and macOS hosted agents.
   """
-  The Xcode version to pre-select (via xcode-select) on macOS hosted agent instances for this cluster queue.
-  """
-  baseImageXcodeVersion: String
+  platformSettings: HostedAgentPlatformSettings
+}
 
+"""
+Possible sizes for the hosted agent instance, specifying vCPU and memory allocations.
+"""
+enum HostedAgentSize {
   """
-  Specifies the type of machine used for the hosted agent instance in this cluster queue (e.g., Linux or MacOS).
+  Extra large capacity size: 12 vCPU, 28GB RAM (Linux); Not applicable for macOS.
   """
-  machineType: HostedAgentMachineType
+  EXTRA_LARGE
 
   """
-  The amount of memory (in GB) available on each hosted agent instance in this cluster queue.
+  Large capacity size: 8 vCPU, 32GB RAM (Linux); 12 vCPU, 28GB RAM (macOS).
   """
-  memory: Int
+  LARGE
 
   """
-  The overall size classification of the hosted agent instance, combining vCPU and memory, used in this cluster queue.
+  Medium capacity size: 4 vCPU, 16GB RAM (Linux); 6 vCPU, 14GB RAM (macOS).
   """
-  size: HostedAgentSize
+  MEDIUM
 
   """
-  The number of CPU cores allocated to the hosted agent instance in this cluster queue.
+  Small capacity size: 2 vCPU, 4GB RAM (Linux); 4 vCPU, 7GB RAM (macOS).
   """
-  vcpu: Int
+  SMALL
 }
 
 """

data/nav_graphql.yml

@@ -388,8 +388,16 @@
     path: apis/graphql/schemas/object/graphqlsnippet
   - name: GraphQLSnippetCreatePayload
     path: apis/graphql/schemas/object/graphqlsnippetcreatepayload
-  - name: HostedConfigurationType
-    path: apis/graphql/schemas/object/hostedconfigurationtype
+  - name: HostedAgentInstanceShape
+    path: apis/graphql/schemas/object/hostedagentinstanceshape
+  - name: HostedAgentLinuxSettings
+    path: apis/graphql/schemas/object/hostedagentlinuxsettings
+  - name: HostedAgentMacOSSettingsType
+    path: apis/graphql/schemas/object/hostedagentmacossettingstype
+  - name: HostedAgentPlatformSettings
+    path: apis/graphql/schemas/object/hostedagentplatformsettings
+  - name: HostedAgentQueueSettings
+    path: apis/graphql/schemas/object/hostedagentqueuesettings
   - name: JobConcurrency
     path: apis/graphql/schemas/object/jobconcurrency
   - name: JobConnection