MORPH-15040: API docs for cluster UUID support

components/parameters/clusterIdOrUuid-path.yaml

@@ -0,0 +1,7 @@
+name: clusterId
+in: path
+description: The numeric ID or the UUID of the cluster.
+required: true
+schema:
+  type: string
+example: '5'

components/parameters/clustersUuid.yaml

@@ -0,0 +1,5 @@
+name: uuid
+in: query
+description: Filter by cluster UUID. Repeat the parameter to filter by multiple UUIDs (`?uuid=A&uuid=B`); UUIDs that don't match are ignored.
+schema:
+  type: string

components/schemas/clusters.yaml

@@ -3,6 +3,8 @@ properties:
   id:
     type: integer
     format: int64
+  uuid:
+    type: string
   name:
     type: string
   code:

paths/api@clusters.yaml

@@ -15,6 +15,7 @@ get:
     - $ref: ../components/parameters/typeId.yaml
     - $ref: ../components/parameters/labels.yaml
     - $ref: ../components/parameters/allLabels.yaml
+    - $ref: ../components/parameters/clustersUuid.yaml
   responses:
     '200':
       description: Successful Request

paths/api@clusters@id.yaml

@@ -1,11 +1,11 @@
 get:
   summary: Get a Specific Cluster
-  description: This endpoint retrieves a specific cluster.
+  description: This endpoint retrieves a specific cluster. The path segment accepts either the numeric cluster ID or the cluster UUID string.
   operationId: getCluster
   tags:
     - Clusters
   parameters:
-    - $ref: ../components/parameters/clusterId-path.yaml
+    - $ref: ../components/parameters/clusterIdOrUuid-path.yaml
     - in: query
       name: stats
       description: This can be used to include the cluster `stats` object in the response by passing `true`. This object includes usage information that varies by cluster type. For example for HVM it may include `cephStats` and `pacemakerStats`.