@red-hat-developer-hub/backstage-plugin-bulk-import-backend 6.2.0 → 6.4.0

package/dist/generated/openapidocument.cjs.js

@@ -84,6 +84,9 @@ const OPENAPI = `
           },
           {
             "$ref": "#/components/parameters/searchQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
           }
         ],
         "responses": {
@@ -159,6 +162,9 @@ const OPENAPI = `
           },
           {
             "$ref": "#/components/parameters/searchQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
           }
         ],
         "responses": {
@@ -225,6 +231,9 @@ const OPENAPI = `
           },
           {
             "$ref": "#/components/parameters/searchQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
           }
         ],
         "responses": {
@@ -297,6 +306,9 @@ const OPENAPI = `
           },
           {
             "$ref": "#/components/parameters/searchQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
           }
         ],
         "responses": {
@@ -416,6 +428,223 @@ const OPENAPI = `
         }
       }
     },
+    "/task-imports": {
+      "get": {
+        "operationId": "findAllTaskImports",
+        "summary": "Fetch Import Jobs",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/apiVersionHeaderParam"
+          },
+          {
+            "$ref": "#/components/parameters/pagePerIntegrationQueryParamDeprecated"
+          },
+          {
+            "$ref": "#/components/parameters/sizePerIntegrationQueryParamDeprecated"
+          },
+          {
+            "$ref": "#/components/parameters/pageQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/sizeQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/sortOrderQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/sortColumnQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/searchQueryParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Import Job list was fetched successfully with no errors",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/SourceImport"
+                      }
+                    },
+                    {
+                      "$ref": "#/components/schemas/ImportJobListV2"
+                    }
+                  ]
+                },
+                "examples": {
+                  "twoImports": {
+                    "$ref": "#/components/examples/twoImports"
+                  },
+                  "multipleImportJobsV2": {
+                    "$ref": "#/components/examples/multipleImportJobsV2"
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Generic error when there are errors and no Import Job is returned",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "type": "string",
+                      "description": "Generic error"
+                    },
+                    {
+                      "$ref": "#/components/schemas/ImportJobListV2"
+                    }
+                  ]
+                },
+                "examples": {
+                  "repositoryListErrors": {
+                    "$ref": "#/components/examples/importJobListErrors"
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "createTaskImportJobs",
+        "summary": "Execute a scaffolder template for a list of repositories",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "requestBody": {
+          "description": "The template to execute and the repositories to run it against.",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ImportRequest"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "202": {
+            "description": "Import Jobs request was submitted successfully to the API. Check the status in each item of the response body list to see their individual status.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Import"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/task-import/by-repo": {
+      "get": {
+        "operationId": "findTaskImportStatusByRepo",
+        "summary": "Get Import Status by repository",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "repo",
+            "description": "the full URL to the repo",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "defaultBranch",
+            "description": "the name of the default branch",
+            "schema": {
+              "type": "string",
+              "default": "main"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Import Job status was determined successfully with no errors",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Import"
+                },
+                "examples": {
+                  "singleImportStatusForRepo": {
+                    "$ref": "#/components/examples/singleImportStatusForRepo"
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Generic error"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteTaskImportByRepo",
+        "summary": "Delete stored scaffolder task records for a specific repository",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "repo",
+            "description": "the full URL to the repo",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Repository was deleted successfully with no errors"
+          },
+          "500": {
+            "description": "Generic error"
+          }
+        }
+      }
+    },
     "/import/by-repo": {
       "get": {
         "operationId": "findImportStatusByRepo",
@@ -445,6 +674,9 @@ const OPENAPI = `
               "type": "string",
               "default": "main"
             }
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
           }
         ],
         "responses": {
@@ -496,6 +728,9 @@ const OPENAPI = `
               "type": "string",
               "default": "main"
             }
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
           }
         ],
         "responses": {
@@ -617,6 +852,15 @@ const OPENAPI = `
           "type": "integer",
           "default": 20
         }
+      },
+      "approvalToolParam": {
+        "in": "query",
+        "name": "approvalTool",
+        "description": "the approvalTool to use",
+        "schema": {
+          "type": "string",
+          "default": "GIT"
+        }
       }
     },
     "schemas": {
@@ -727,7 +971,14 @@ const OPENAPI = `
             "description": "organization which the repository is part of"
           },
           "importStatus": {
-            "$ref": "#/components/schemas/ImportStatus"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/ImportStatus"
+              },
+              {
+                "$ref": "#/components/schemas/TaskImportStatus"
+              }
+            ]
           },
           "defaultBranch": {
             "type": "string",
@@ -749,7 +1000,22 @@ const OPENAPI = `
         "type": "string",
         "enum": [
           "GIT",
-          "SERVICENOW"
+          "SERVICENOW",
+          "GITLAB"
+        ]
+      },
+      "TaskImportStatus": {
+        "type": "string",
+        "nullable": true,
+        "description": "Import Job status",
+        "enum": [
+          "TASK_CANCELLED",
+          "TASK_COMPLETED",
+          "TASK_FAILED",
+          "TASK_OPEN",
+          "TASK_PROCESSING",
+          "TASK_SKIPPED",
+          "TASK_FETCH_FAILED"
         ]
       },
       "ImportStatus": {
@@ -798,7 +1064,33 @@ const OPENAPI = `
             "type": "string"
           },
           "status": {
-            "$ref": "#/components/schemas/ImportStatus"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/ImportStatus"
+              },
+              {
+                "$ref": "#/components/schemas/TaskImportStatus"
+              }
+            ]
+          },
+          "task": {
+            "type": "object",
+            "properties": {
+              "taskId": {
+                "type": "string"
+              }
+            }
+          },
+          "tasks": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "taskId": {
+                  "type": "string"
+                }
+              }
+            }
           },
           "catalogEntityName": {
             "type": "string",
@@ -820,39 +1112,59 @@ const OPENAPI = `
           "repository": {
             "$ref": "#/components/schemas/Repository"
           },
+          "gitlab": {
+            "type": "object",
+            "description": "GitLab details. Applicable if approvalTool is gitlab.",
+            "properties": {
+              "pullRequest": {
+                "$ref": "#/components/schemas/PullRequest"
+              }
+            }
+          },
           "github": {
             "type": "object",
             "description": "GitHub details. Applicable if approvalTool is git.",
             "properties": {
               "pullRequest": {
-                "type": "object",
-                "properties": {
-                  "url": {
-                    "type": "string",
-                    "description": "URL of the Pull Request"
-                  },
-                  "number": {
-                    "type": "number",
-                    "description": "Pull Request number"
-                  },
-                  "title": {
-                    "type": "string",
-                    "description": "title of the Pull Request"
-                  },
-                  "body": {
-                    "type": "string",
-                    "description": "body of the Pull Request"
-                  },
-                  "catalogInfoContent": {
-                    "type": "string",
-                    "description": "content of the catalog-info.yaml as fetched from the Pull Request."
-                  }
-                }
+                "$ref": "#/components/schemas/PullRequest"
               }
             }
           }
         }
       },
+      "PullRequest": {
+        "type": "object",
+        "properties": {
+          "url": {
+            "type": "string",
+            "description": "URL of the Pull Request"
+          },
+          "number": {
+            "type": "number",
+            "description": "Pull Request number"
+          },
+          "title": {
+            "type": "string",
+            "description": "title of the Pull Request"
+          },
+          "body": {
+            "type": "string",
+            "description": "body of the Pull Request"
+          },
+          "catalogInfoContent": {
+            "type": "string",
+            "description": "content of the catalog-info.yaml as fetched from the Pull Request."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "WAIT_PR_APPROVAL",
+              "PR_MERGED",
+              "PR_ERROR"
+            ]
+          }
+        }
+      },
       "SourceImport": {
         "title": "Import Job with source it originates from",
         "allOf": [
@@ -926,27 +1238,43 @@ const OPENAPI = `
             "type": "string",
             "description": "content of the catalog-info.yaml to include in the import Pull Request."
           },
+          "gitlab": {
+            "type": "object",
+            "description": "GitLab details. Applicable if approvalTool is gitlab.",
+            "properties": {
+              "pullRequest": {
+                "$ref": "#/components/schemas/PullRequest"
+              }
+            }
+          },
           "github": {
             "type": "object",
             "description": "GitHub details. Applicable if approvalTool is git.",
             "properties": {
               "pullRequest": {
-                "type": "object",
-                "description": "Pull Request details. Applicable if approvalTool is git.",
-                "properties": {
-                  "title": {
-                    "type": "string",
-                    "description": "title of the Pull Request"
-                  },
-                  "body": {
-                    "type": "string",
-                    "description": "body of the Pull Request"
-                  }
-                }
+                "$ref": "#/components/schemas/PullRequest"
               }
             }
           }
         }
+      },
+      "ScaffolderTask": {
+        "title": "Scaffolder Task",
+        "type": "object",
+        "properties": {
+          "taskId": {
+            "type": "string"
+          },
+          "repositoryId": {
+            "type": "number"
+          },
+          "locations": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
       }
     },
     "securitySchemes": {