CloudMigrations: document and re-generate api for syncing (#94063)

* CloudMigrations: document frontend open-api generator steps

* CloudMigrations: re-run api generation

pkg/services/cloudmigration/api/dtos.go

@@ -313,6 +313,11 @@ type GetSnapshotListParams struct {
 	// Session UID of a session
 	// in: path
 	UID string `json:"uid"`
+
+	// Sort with value latest to return results sorted in descending order.
+	// in:query
+	// required:false
+	Sort string `json:"sort"`
 }
 
 // swagger:response snapshotListResponse

public/api-merged.json

@@ -2600,6 +2600,12 @@
             "name": "uid",
             "in": "path",
             "required": true
+          },
+          {
+            "type": "string",
+            "description": "Sort with value latest to return results sorted in descending order.",
+            "name": "sort",
+            "in": "query"
           }
         ],
         "responses": {

public/app/features/migrate-to-cloud/api/README.md

@@ -0,0 +1,6 @@
+## Migrate to Cloud API
+
+The [`endpoints.gen.ts`](./endpoints.gen.ts) file is machine generated. In order to update it, follow these steps:
+
+- Run: `make swagger-clean && make openapi3-gen`
+- Run: `yarn generate-apis`

public/app/features/migrate-to-cloud/api/endpoints.gen.ts

@@ -112,10 +112,10 @@ export type GetShapshotListApiArg = {
   page?: number;
   /** Max limit for results returned. */
   limit?: number;
-  /** Sort with value latest to return results sorted in descending order */
-  sort?: string;
   /** Session UID of a session */
   uid: string;
+  /** Sort with value latest to return results sorted in descending order. */
+  sort?: string;
 };
 export type GetCloudMigrationTokenApiResponse = /** status 200 (empty) */ GetAccessTokenResponseDto;
 export type GetCloudMigrationTokenApiArg = void;
@@ -157,6 +157,7 @@ export type CreateSnapshotResponseDto = {
 };
 export type MigrateDataResponseItemDto = {
   message?: string;
+  name?: string;
   refId: string;
   status: 'OK' | 'WARNING' | 'ERROR' | 'PENDING' | 'UNKNOWN';
   type: 'DASHBOARD' | 'DATASOURCE' | 'FOLDER' | 'LIBRARY_ELEMENT';

public/openapi3.json

@@ -15802,6 +15802,14 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "description": "Sort with value latest to return results sorted in descending order.",
+            "in": "query",
+            "name": "sort",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {