diff --git a/workspaces/bulk-import/.changeset/curly-peaches-build.md b/workspaces/bulk-import/.changeset/curly-peaches-build.md new file mode 100644 index 0000000000..de4b8cf9c0 --- /dev/null +++ b/workspaces/bulk-import/.changeset/curly-peaches-build.md @@ -0,0 +1,7 @@ +--- +'@red-hat-developer-hub/backstage-plugin-bulk-import-backend': patch +'@red-hat-developer-hub/backstage-plugin-bulk-import-common': patch +'@red-hat-developer-hub/backstage-plugin-bulk-import': patch +--- + +Updated dependency `prettier` to `3.7.4`. diff --git a/workspaces/bulk-import/.prettierignore b/workspaces/bulk-import/.prettierignore index 1cfaa89479..e8df4e42df 100644 --- a/workspaces/bulk-import/.prettierignore +++ b/workspaces/bulk-import/.prettierignore @@ -3,3 +3,8 @@ dist-types coverage .vscode .eslintrc.js + +# Generated +plugins/bulk-import-backend/api-docs +plugins/bulk-import-backend/src/generated/openapi.d.ts +plugins/bulk-import-backend/src/generated/openapidocument.ts \ No newline at end of file diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ImportApi.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ImportApi.md index 7e73e6c01a..64a5793f77 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ImportApi.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ImportApi.md @@ -1,32 +1,31 @@ # ImportApi -All URIs are relative to _http://localhost:7007/api/bulk-import_ - -| Method | HTTP request | Description | -| ------------------------------------------------------------------------- | ------------------------------- | --------------------------------------------------------------- | -| [**createImportJobs**](ImportApi.md#createImportJobs) | **POST** /imports | Submit Import Jobs | -| [**createTaskImportJobs**](ImportApi.md#createTaskImportJobs) | **POST** /task-imports | Execute a scaffolder template for a list of repositories | -| [**deleteImportByRepo**](ImportApi.md#deleteImportByRepo) | **DELETE** /import/by-repo | Delete Import by repository | -| [**deleteTaskImportByRepo**](ImportApi.md#deleteTaskImportByRepo) | **DELETE** /task-import/by-repo | Delete stored scaffolder task records for a specific repository | -| [**findAllImports**](ImportApi.md#findAllImports) | **GET** /imports | Fetch Import Jobs | -| [**findAllTaskImports**](ImportApi.md#findAllTaskImports) | **GET** /task-imports | Fetch Import Jobs | -| [**findImportStatusByRepo**](ImportApi.md#findImportStatusByRepo) | **GET** /import/by-repo | Get Import Status by repository | -| [**findTaskImportStatusByRepo**](ImportApi.md#findTaskImportStatusByRepo) | **GET** /task-import/by-repo | Get Import Status by repository | +All URIs are relative to *http://localhost:7007/api/bulk-import* - +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**createImportJobs**](ImportApi.md#createImportJobs) | **POST** /imports | Submit Import Jobs | +| [**createTaskImportJobs**](ImportApi.md#createTaskImportJobs) | **POST** /task-imports | Execute a scaffolder template for a list of repositories | +| [**deleteImportByRepo**](ImportApi.md#deleteImportByRepo) | **DELETE** /import/by-repo | Delete Import by repository | +| [**deleteTaskImportByRepo**](ImportApi.md#deleteTaskImportByRepo) | **DELETE** /task-import/by-repo | Delete stored scaffolder task records for a specific repository | +| [**findAllImports**](ImportApi.md#findAllImports) | **GET** /imports | Fetch Import Jobs | +| [**findAllTaskImports**](ImportApi.md#findAllTaskImports) | **GET** /task-imports | Fetch Import Jobs | +| [**findImportStatusByRepo**](ImportApi.md#findImportStatusByRepo) | **GET** /import/by-repo | Get Import Status by repository | +| [**findTaskImportStatusByRepo**](ImportApi.md#findTaskImportStatusByRepo) | **GET** /task-import/by-repo | Get Import Status by repository | -# **createImportJobs** + +# **createImportJobs** > List createImportJobs(ImportRequest, dryRun) Submit Import Jobs ### Parameters -| Name | Type | Description | Notes | -| ----------------- | -------------------------------------- | ------------------------------------------------------------------------------------------ | ----------------------------- | -| **ImportRequest** | [**List**](../Models/ImportRequest.md) | List of Import jobs to create | | -| **dryRun** | **Boolean** | whether to perform a dry-run to check if entity name collisions would occur in the catalog | [optional] [default to false] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **ImportRequest** | [**List**](../Models/ImportRequest.md)| List of Import jobs to create | | +| **dryRun** | **Boolean**| whether to perform a dry-run to check if entity name collisions would occur in the catalog | [optional] [default to false] | ### Return type @@ -42,18 +41,16 @@ Submit Import Jobs - **Accept**: application/json - # **createTaskImportJobs** - > List createTaskImportJobs(ImportRequest) Execute a scaffolder template for a list of repositories ### Parameters -| Name | Type | Description | Notes | -| ----------------- | -------------------------------------- | --------------------------------------------------------------- | ----- | -| **ImportRequest** | [**List**](../Models/ImportRequest.md) | The template to execute and the repositories to run it against. | | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **ImportRequest** | [**List**](../Models/ImportRequest.md)| The template to execute and the repositories to run it against. | | ### Return type @@ -69,20 +66,18 @@ Execute a scaffolder template for a list of repositories - **Accept**: application/json - # **deleteImportByRepo** - > deleteImportByRepo(repo, defaultBranch, approvalTool) Delete Import by repository ### Parameters -| Name | Type | Description | Notes | -| ----------------- | ---------- | ------------------------------ | ---------------------------- | -| **repo** | **String** | the full URL to the repo | [optional] [default to null] | -| **defaultBranch** | **String** | the name of the default branch | [optional] [default to main] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **repo** | **String**| the full URL to the repo | [optional] [default to null] | +| **defaultBranch** | **String**| the name of the default branch | [optional] [default to main] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -98,19 +93,17 @@ null (empty response body) - **Accept**: Not defined - # **deleteTaskImportByRepo** - > deleteTaskImportByRepo(repo, approvalTool) Delete stored scaffolder task records for a specific repository ### Parameters -| Name | Type | Description | Notes | -| ---------------- | ---------- | ------------------------ | ---------------------------- | -| **repo** | **String** | the full URL to the repo | [optional] [default to null] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **repo** | **String**| the full URL to the repo | [optional] [default to null] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -126,26 +119,24 @@ null (empty response body) - **Accept**: Not defined - # **findAllImports** - > findAllImports_200_response findAllImports(api-version, pagePerIntegration, sizePerIntegration, page, size, sortOrder, sortColumn, search, approvalTool) Fetch Import Jobs ### Parameters -| Name | Type | Description | Notes | -| ---------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| **api-version** | **String** | API version. ## Changelog ### v1 (default) Initial version #### Deprecations _ GET /imports _ Deprecation of 'pagePerIntegration' and 'sizePerIntegration' query parameters and introduction of new 'page' and 'size' parameters _ 'page' takes precedence over 'pagePerIntegration' if both are passed _ 'size' takes precedence over 'sizePerIntegration' if both are passed ### v2 #### Breaking changes _ GET /imports _ Query parameters: _ 'pagePerIntegration' is ignored in favor of 'page' _ 'sizePerIntegration' is ignored in favor of 'size' _ Response structure changed to include pagination info: instead of returning a simple list of Imports, the response is now an object containing the following fields: _ 'imports': the list of Imports _ 'page': the page requested _ 'size': the requested number of Imports requested per page \* 'totalCount': the total count of Imports | [optional] [default to v1] [enum: v1, v2] | -| **pagePerIntegration** | **Integer** | the page number for each Integration. **Deprecated**. Use the 'page' query parameter instead. | [optional] [default to 1] | -| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page. **Deprecated**. Use the 'size' query parameter instead. | [optional] [default to 20] | -| **page** | **Integer** | the requested page number | [optional] [default to 1] | -| **size** | **Integer** | the number of items to return per page | [optional] [default to 20] | -| **sortOrder** | **String** | The order of sorting asc for ascending or desc for descending | [optional] [default to asc] [enum: asc, desc] | -| **sortColumn** | **String** | The allowed values for sorting columns: - repository.name: Sort by repository name. - repository.organization: Sort by organization URL. - repository.url: Sort by repository URL. - lastUpdate: Sort by the last time the catalog-info.yaml was updated. - status: Sort by the status of the catalog-info.yaml. | [optional] [default to repository.name] [enum: repository.name, repository.organization, repository.url, lastUpdate, status] | -| **search** | **String** | returns only the items that match the search string | [optional] [default to null] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **api-version** | **String**| API version. ## Changelog ### v1 (default) Initial version #### Deprecations * GET /imports * Deprecation of 'pagePerIntegration' and 'sizePerIntegration' query parameters and introduction of new 'page' and 'size' parameters * 'page' takes precedence over 'pagePerIntegration' if both are passed * 'size' takes precedence over 'sizePerIntegration' if both are passed ### v2 #### Breaking changes * GET /imports * Query parameters: * 'pagePerIntegration' is ignored in favor of 'page' * 'sizePerIntegration' is ignored in favor of 'size' * Response structure changed to include pagination info: instead of returning a simple list of Imports, the response is now an object containing the following fields: * 'imports': the list of Imports * 'page': the page requested * 'size': the requested number of Imports requested per page * 'totalCount': the total count of Imports | [optional] [default to v1] [enum: v1, v2] | +| **pagePerIntegration** | **Integer**| the page number for each Integration. **Deprecated**. Use the 'page' query parameter instead. | [optional] [default to 1] | +| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page. **Deprecated**. Use the 'size' query parameter instead. | [optional] [default to 20] | +| **page** | **Integer**| the requested page number | [optional] [default to 1] | +| **size** | **Integer**| the number of items to return per page | [optional] [default to 20] | +| **sortOrder** | **String**| The order of sorting asc for ascending or desc for descending | [optional] [default to asc] [enum: asc, desc] | +| **sortColumn** | **String**| The allowed values for sorting columns: - repository.name: Sort by repository name. - repository.organization: Sort by organization URL. - repository.url: Sort by repository URL. - lastUpdate: Sort by the last time the catalog-info.yaml was updated. - status: Sort by the status of the catalog-info.yaml. | [optional] [default to repository.name] [enum: repository.name, repository.organization, repository.url, lastUpdate, status] | +| **search** | **String**| returns only the items that match the search string | [optional] [default to null] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -161,25 +152,23 @@ Fetch Import Jobs - **Accept**: application/json - # **findAllTaskImports** - > findAllImports_200_response findAllTaskImports(api-version, pagePerIntegration, sizePerIntegration, page, size, sortOrder, sortColumn, search) Fetch Import Jobs ### Parameters -| Name | Type | Description | Notes | -| ---------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| **api-version** | **String** | API version. ## Changelog ### v1 (default) Initial version #### Deprecations _ GET /imports _ Deprecation of 'pagePerIntegration' and 'sizePerIntegration' query parameters and introduction of new 'page' and 'size' parameters _ 'page' takes precedence over 'pagePerIntegration' if both are passed _ 'size' takes precedence over 'sizePerIntegration' if both are passed ### v2 #### Breaking changes _ GET /imports _ Query parameters: _ 'pagePerIntegration' is ignored in favor of 'page' _ 'sizePerIntegration' is ignored in favor of 'size' _ Response structure changed to include pagination info: instead of returning a simple list of Imports, the response is now an object containing the following fields: _ 'imports': the list of Imports _ 'page': the page requested _ 'size': the requested number of Imports requested per page \* 'totalCount': the total count of Imports | [optional] [default to v1] [enum: v1, v2] | -| **pagePerIntegration** | **Integer** | the page number for each Integration. **Deprecated**. Use the 'page' query parameter instead. | [optional] [default to 1] | -| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page. **Deprecated**. Use the 'size' query parameter instead. | [optional] [default to 20] | -| **page** | **Integer** | the requested page number | [optional] [default to 1] | -| **size** | **Integer** | the number of items to return per page | [optional] [default to 20] | -| **sortOrder** | **String** | The order of sorting asc for ascending or desc for descending | [optional] [default to asc] [enum: asc, desc] | -| **sortColumn** | **String** | The allowed values for sorting columns: - repository.name: Sort by repository name. - repository.organization: Sort by organization URL. - repository.url: Sort by repository URL. - lastUpdate: Sort by the last time the catalog-info.yaml was updated. - status: Sort by the status of the catalog-info.yaml. | [optional] [default to repository.name] [enum: repository.name, repository.organization, repository.url, lastUpdate, status] | -| **search** | **String** | returns only the items that match the search string | [optional] [default to null] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **api-version** | **String**| API version. ## Changelog ### v1 (default) Initial version #### Deprecations * GET /imports * Deprecation of 'pagePerIntegration' and 'sizePerIntegration' query parameters and introduction of new 'page' and 'size' parameters * 'page' takes precedence over 'pagePerIntegration' if both are passed * 'size' takes precedence over 'sizePerIntegration' if both are passed ### v2 #### Breaking changes * GET /imports * Query parameters: * 'pagePerIntegration' is ignored in favor of 'page' * 'sizePerIntegration' is ignored in favor of 'size' * Response structure changed to include pagination info: instead of returning a simple list of Imports, the response is now an object containing the following fields: * 'imports': the list of Imports * 'page': the page requested * 'size': the requested number of Imports requested per page * 'totalCount': the total count of Imports | [optional] [default to v1] [enum: v1, v2] | +| **pagePerIntegration** | **Integer**| the page number for each Integration. **Deprecated**. Use the 'page' query parameter instead. | [optional] [default to 1] | +| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page. **Deprecated**. Use the 'size' query parameter instead. | [optional] [default to 20] | +| **page** | **Integer**| the requested page number | [optional] [default to 1] | +| **size** | **Integer**| the number of items to return per page | [optional] [default to 20] | +| **sortOrder** | **String**| The order of sorting asc for ascending or desc for descending | [optional] [default to asc] [enum: asc, desc] | +| **sortColumn** | **String**| The allowed values for sorting columns: - repository.name: Sort by repository name. - repository.organization: Sort by organization URL. - repository.url: Sort by repository URL. - lastUpdate: Sort by the last time the catalog-info.yaml was updated. - status: Sort by the status of the catalog-info.yaml. | [optional] [default to repository.name] [enum: repository.name, repository.organization, repository.url, lastUpdate, status] | +| **search** | **String**| returns only the items that match the search string | [optional] [default to null] | ### Return type @@ -195,20 +184,18 @@ Fetch Import Jobs - **Accept**: application/json - # **findImportStatusByRepo** - > Import findImportStatusByRepo(repo, defaultBranch, approvalTool) Get Import Status by repository ### Parameters -| Name | Type | Description | Notes | -| ----------------- | ---------- | ------------------------------ | ---------------------------- | -| **repo** | **String** | the full URL to the repo | [optional] [default to null] | -| **defaultBranch** | **String** | the name of the default branch | [optional] [default to main] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **repo** | **String**| the full URL to the repo | [optional] [default to null] | +| **defaultBranch** | **String**| the name of the default branch | [optional] [default to main] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -224,20 +211,18 @@ Get Import Status by repository - **Accept**: application/json - # **findTaskImportStatusByRepo** - > Import findTaskImportStatusByRepo(repo, defaultBranch, approvalTool) Get Import Status by repository ### Parameters -| Name | Type | Description | Notes | -| ----------------- | ---------- | ------------------------------ | ---------------------------- | -| **repo** | **String** | the full URL to the repo | [optional] [default to null] | -| **defaultBranch** | **String** | the name of the default branch | [optional] [default to main] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **repo** | **String**| the full URL to the repo | [optional] [default to null] | +| **defaultBranch** | **String**| the name of the default branch | [optional] [default to main] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -251,3 +236,4 @@ Get Import Status by repository - **Content-Type**: Not defined - **Accept**: application/json + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ManagementApi.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ManagementApi.md index 55d365f55e..b2ff8388f1 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ManagementApi.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ManagementApi.md @@ -1,21 +1,19 @@ # ManagementApi -All URIs are relative to _http://localhost:7007/api/bulk-import_ +All URIs are relative to *http://localhost:7007/api/bulk-import* -| Method | HTTP request | Description | -| --------------------------------- | ------------- | -------------------------------------------------- | +| Method | HTTP request | Description | +|------------- | ------------- | -------------| | [**ping**](ManagementApi.md#ping) | **GET** /ping | Check the health of the Bulk Import backend router | - + # **ping** - > ping_200_response ping() Check the health of the Bulk Import backend router ### Parameters - This endpoint does not need any parameter. ### Return type @@ -30,3 +28,4 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/OrganizationApi.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/OrganizationApi.md index ca34e3c742..b8b1d09c92 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/OrganizationApi.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/OrganizationApi.md @@ -1,28 +1,27 @@ # OrganizationApi -All URIs are relative to _http://localhost:7007/api/bulk-import_ +All URIs are relative to *http://localhost:7007/api/bulk-import* -| Method | HTTP request | Description | -| --------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | -| [**findAllOrganizations**](OrganizationApi.md#findAllOrganizations) | **GET** /organizations | Fetch Organizations accessible by Backstage Github Integrations | +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**findAllOrganizations**](OrganizationApi.md#findAllOrganizations) | **GET** /organizations | Fetch Organizations accessible by Backstage Github Integrations | | [**findRepositoriesByOrganization**](OrganizationApi.md#findRepositoriesByOrganization) | **GET** /organizations/{organizationName}/repositories | Fetch Repositories in the specified GitHub organization, provided it is accessible by any of the configured GitHub Integrations. | - + # **findAllOrganizations** - > OrganizationList findAllOrganizations(pagePerIntegration, sizePerIntegration, search, approvalTool) Fetch Organizations accessible by Backstage Github Integrations ### Parameters -| Name | Type | Description | Notes | -| ---------------------- | ----------- | ------------------------------------------------------ | ---------------------------- | -| **pagePerIntegration** | **Integer** | the page number for each Integration | [optional] [default to 1] | -| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page | [optional] [default to 20] | -| **search** | **String** | returns only the items that match the search string | [optional] [default to null] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pagePerIntegration** | **Integer**| the page number for each Integration | [optional] [default to 1] | +| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] | +| **search** | **String**| returns only the items that match the search string | [optional] [default to null] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -38,23 +37,21 @@ Fetch Organizations accessible by Backstage Github Integrations - **Accept**: application/json - # **findRepositoriesByOrganization** - > RepositoryList findRepositoriesByOrganization(organizationName, checkImportStatus, pagePerIntegration, sizePerIntegration, search, approvalTool) Fetch Repositories in the specified GitHub organization, provided it is accessible by any of the configured GitHub Integrations. ### Parameters -| Name | Type | Description | Notes | -| ---------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| **organizationName** | **String** | Organization name | [default to null] | -| **checkImportStatus** | **Boolean** | whether to return import status. Note that this might incur a performance penalty because the import status is computed for each repository. | [optional] [default to false] | -| **pagePerIntegration** | **Integer** | the page number for each Integration | [optional] [default to 1] | -| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page | [optional] [default to 20] | -| **search** | **String** | returns only the items that match the search string | [optional] [default to null] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **organizationName** | **String**| Organization name | [default to null] | +| **checkImportStatus** | **Boolean**| whether to return import status. Note that this might incur a performance penalty because the import status is computed for each repository. | [optional] [default to false] | +| **pagePerIntegration** | **Integer**| the page number for each Integration | [optional] [default to 1] | +| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] | +| **search** | **String**| returns only the items that match the search string | [optional] [default to null] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -68,3 +65,4 @@ Fetch Repositories in the specified GitHub organization, provided it is accessib - **Content-Type**: Not defined - **Accept**: application/json + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/RepositoryApi.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/RepositoryApi.md index 7b48f833c3..801f72290a 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/RepositoryApi.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/RepositoryApi.md @@ -1,28 +1,27 @@ # RepositoryApi -All URIs are relative to _http://localhost:7007/api/bulk-import_ +All URIs are relative to *http://localhost:7007/api/bulk-import* -| Method | HTTP request | Description | -| --------------------------------------------------------------- | --------------------- | --------------------------------------------------------------------------- | +| Method | HTTP request | Description | +|------------- | ------------- | -------------| | [**findAllRepositories**](RepositoryApi.md#findAllRepositories) | **GET** /repositories | Fetch Organization Repositories accessible by Backstage Github Integrations | - + # **findAllRepositories** - > RepositoryList findAllRepositories(checkImportStatus, pagePerIntegration, sizePerIntegration, search, approvalTool) Fetch Organization Repositories accessible by Backstage Github Integrations ### Parameters -| Name | Type | Description | Notes | -| ---------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| **checkImportStatus** | **Boolean** | whether to return import status. Note that this might incur a performance penalty because the import status is computed for each repository. | [optional] [default to false] | -| **pagePerIntegration** | **Integer** | the page number for each Integration | [optional] [default to 1] | -| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page | [optional] [default to 20] | -| **search** | **String** | returns only the items that match the search string | [optional] [default to null] | -| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] | +|Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **checkImportStatus** | **Boolean**| whether to return import status. Note that this might incur a performance penalty because the import status is computed for each repository. | [optional] [default to false] | +| **pagePerIntegration** | **Integer**| the page number for each Integration | [optional] [default to 1] | +| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] | +| **search** | **String**| returns only the items that match the search string | [optional] [default to null] | +| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] | ### Return type @@ -36,3 +35,4 @@ Fetch Organization Repositories accessible by Backstage Github Integrations - **Content-Type**: Not defined - **Accept**: application/json + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ApprovalTool.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ApprovalTool.md index b254f17138..f041dd92ad 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ApprovalTool.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ApprovalTool.md @@ -1,8 +1,8 @@ # ApprovalTool - ## Properties | Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +|------------ | ------------- | ------------- | -------------| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import.md index 69bce9bdd9..2298e81455 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import.md @@ -1,19 +1,19 @@ # Import - ## Properties -| Name | Type | Description | Notes | -| --------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------- | -| **id** | **String** | | [optional] [default to null] | -| **status** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] | -| **task** | [**Import_task**](Import_task.md) | | [optional] [default to null] | -| **tasks** | [**List**](Import_task.md) | | [optional] [default to null] | -| **catalogEntityName** | **String** | Specified entity name in the catalog. Filled only in response for dry-run import requests. | [optional] [default to null] | -| **lastUpdate** | **Date** | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | -| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] | -| **repository** | [**Repository**](Repository.md) | | [optional] [default to null] | -| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] | -| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **id** | **String** | | [optional] [default to null] | +| **status** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] | +| **task** | [**Import_task**](Import_task.md) | | [optional] [default to null] | +| **tasks** | [**List**](Import_task.md) | | [optional] [default to null] | +| **catalogEntityName** | **String** | Specified entity name in the catalog. Filled only in response for dry-run import requests. | [optional] [default to null] | +| **lastUpdate** | **Date** | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | +| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] | +| **repository** | [**Repository**](Repository.md) | | [optional] [default to null] | +| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] | +| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportJobListV2.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportJobListV2.md index 5ae43d213b..ff9813548e 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportJobListV2.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportJobListV2.md @@ -1,13 +1,13 @@ # ImportJobListV2 - ## Properties -| Name | Type | Description | Notes | -| -------------- | --------------------------- | ----------- | ---------------------------- | -| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | -| **totalCount** | **Integer** | | [optional] [default to null] | -| **page** | **Integer** | | [optional] [default to null] | -| **size** | **Integer** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | +| **totalCount** | **Integer** | | [optional] [default to null] | +| **page** | **Integer** | | [optional] [default to null] | +| **size** | **Integer** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest.md index 397b7b3808..9b6d3e282c 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest.md @@ -1,15 +1,15 @@ # ImportRequest - ## Properties -| Name | Type | Description | Notes | -| ------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] | -| **catalogEntityName** | **String** | Expected Entity name in the catalog. Relevant only if the 'dryRun' query parameter is set to 'true'. | [optional] [default to null] | -| **codeOwnersFileAsEntityOwner** | **Boolean** | Whether the CODEOWNERS file will be used as entity owner. Only relevant for dry-run requests. If set to 'false', the corresponding dry-run check will be skipped. | [optional] [default to null] | -| **repository** | [**ImportRequest_repository**](ImportRequest_repository.md) | | [default to null] | -| **catalogInfoContent** | **String** | content of the catalog-info.yaml to include in the import Pull Request. | [optional] [default to null] | -| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] | -| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] | +| **catalogEntityName** | **String** | Expected Entity name in the catalog. Relevant only if the 'dryRun' query parameter is set to 'true'. | [optional] [default to null] | +| **codeOwnersFileAsEntityOwner** | **Boolean** | Whether the CODEOWNERS file will be used as entity owner. Only relevant for dry-run requests. If set to 'false', the corresponding dry-run check will be skipped. | [optional] [default to null] | +| **repository** | [**ImportRequest_repository**](ImportRequest_repository.md) | | [default to null] | +| **catalogInfoContent** | **String** | content of the catalog-info.yaml to include in the import Pull Request. | [optional] [default to null] | +| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] | +| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest_repository.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest_repository.md index 42d790f174..ec2686952b 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest_repository.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportRequest_repository.md @@ -1,12 +1,12 @@ # ImportRequest_repository - ## Properties -| Name | Type | Description | Notes | -| ----------------- | ---------- | -------------------------------------------- | ---------------------------- | -| **name** | **String** | repository name | [optional] [default to null] | -| **url** | **String** | repository URL | [default to null] | -| **organization** | **String** | organization which the repository is part of | [optional] [default to null] | -| **defaultBranch** | **String** | default branch | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **name** | **String** | repository name | [optional] [default to null] | +| **url** | **String** | repository URL | [default to null] | +| **organization** | **String** | organization which the repository is part of | [optional] [default to null] | +| **defaultBranch** | **String** | default branch | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportStatus.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportStatus.md index cd0f5e378c..fc352847ff 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportStatus.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportStatus.md @@ -1,8 +1,8 @@ # ImportStatus - ## Properties | Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +|------------ | ------------- | ------------- | -------------| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_github.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_github.md index 568eb846cc..c17129beda 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_github.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_github.md @@ -1,9 +1,9 @@ # Import_github - ## Properties -| Name | Type | Description | Notes | -| --------------- | --------------------------------- | ----------- | ---------------------------- | -| **pullRequest** | [**PullRequest**](PullRequest.md) | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **pullRequest** | [**PullRequest**](PullRequest.md) | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_gitlab.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_gitlab.md index e6f25e2e38..f74032c882 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_gitlab.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_gitlab.md @@ -1,9 +1,9 @@ # Import_gitlab - ## Properties -| Name | Type | Description | Notes | -| --------------- | --------------------------------- | ----------- | ---------------------------- | -| **pullRequest** | [**PullRequest**](PullRequest.md) | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **pullRequest** | [**PullRequest**](PullRequest.md) | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_task.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_task.md index 9b7e7ba7eb..7938d50fa9 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_task.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import_task.md @@ -1,9 +1,9 @@ # Import_task - ## Properties -| Name | Type | Description | Notes | -| ---------- | ---------- | ----------- | ---------------------------- | -| **taskId** | **String** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **taskId** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Organization.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Organization.md index f21a4b34b6..d46faf1df8 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Organization.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Organization.md @@ -1,14 +1,14 @@ # Organization - ## Properties -| Name | Type | Description | Notes | -| ------------------ | -------------- | ------------------------------------------------- | ---------------------------- | -| **id** | **String** | unique identifier | [optional] [default to null] | -| **name** | **String** | organization name | [optional] [default to null] | -| **description** | **String** | organization description | [optional] [default to null] | -| **url** | **String** | organization URL | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **id** | **String** | unique identifier | [optional] [default to null] | +| **name** | **String** | organization name | [optional] [default to null] | +| **description** | **String** | organization description | [optional] [default to null] | +| **url** | **String** | organization URL | [optional] [default to null] | | **totalRepoCount** | **BigDecimal** | total number of repositories in this Organization | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/OrganizationList.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/OrganizationList.md index f2edd2bcb5..4623efc978 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/OrganizationList.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/OrganizationList.md @@ -1,13 +1,13 @@ # OrganizationList - ## Properties -| Name | Type | Description | Notes | -| ---------------------- | --------------------------- | ----------- | ---------------------------- | -| **organizations** | [**List**](Organization.md) | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | -| **totalCount** | **Integer** | | [optional] [default to null] | -| **pagePerIntegration** | **Integer** | | [optional] [default to null] | -| **sizePerIntegration** | **Integer** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **organizations** | [**List**](Organization.md) | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | +| **totalCount** | **Integer** | | [optional] [default to null] | +| **pagePerIntegration** | **Integer** | | [optional] [default to null] | +| **sizePerIntegration** | **Integer** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/PullRequest.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/PullRequest.md index e178568b9f..bc4d5ab7f6 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/PullRequest.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/PullRequest.md @@ -1,14 +1,14 @@ # PullRequest - ## Properties -| Name | Type | Description | Notes | -| ---------------------- | -------------- | ------------------------------------------------------------------ | ---------------------------- | -| **url** | **String** | URL of the Pull Request | [optional] [default to null] | -| **number** | **BigDecimal** | Pull Request number | [optional] [default to null] | -| **title** | **String** | title of the Pull Request | [optional] [default to null] | -| **body** | **String** | body of the Pull Request | [optional] [default to null] | -| **catalogInfoContent** | **String** | content of the catalog-info.yaml as fetched from the Pull Request. | [optional] [default to null] | -| **status** | **String** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **url** | **String** | URL of the Pull Request | [optional] [default to null] | +| **number** | **BigDecimal** | Pull Request number | [optional] [default to null] | +| **title** | **String** | title of the Pull Request | [optional] [default to null] | +| **body** | **String** | body of the Pull Request | [optional] [default to null] | +| **catalogInfoContent** | **String** | content of the catalog-info.yaml as fetched from the Pull Request. | [optional] [default to null] | +| **status** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository.md index 6da30d5424..dadc2da199 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository.md @@ -1,16 +1,16 @@ # Repository - ## Properties -| Name | Type | Description | Notes | -| ----------------- | --------------------------------------------------------- | -------------------------------------------- | ---------------------------- | -| **id** | **String** | unique identifier | [optional] [default to null] | -| **name** | **String** | repository name | [optional] [default to null] | -| **url** | **String** | repository URL | [optional] [default to null] | -| **organization** | **String** | organization which the repository is part of | [optional] [default to null] | -| **importStatus** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] | -| **defaultBranch** | **String** | default branch | [optional] [default to null] | -| **lastUpdate** | **Date** | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **id** | **String** | unique identifier | [optional] [default to null] | +| **name** | **String** | repository name | [optional] [default to null] | +| **url** | **String** | repository URL | [optional] [default to null] | +| **organization** | **String** | organization which the repository is part of | [optional] [default to null] | +| **importStatus** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] | +| **defaultBranch** | **String** | default branch | [optional] [default to null] | +| **lastUpdate** | **Date** | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/RepositoryList.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/RepositoryList.md index 3a99ca52a8..8de5e988c0 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/RepositoryList.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/RepositoryList.md @@ -1,13 +1,13 @@ # RepositoryList - ## Properties -| Name | Type | Description | Notes | -| ---------------------- | ------------------------- | ----------- | ---------------------------- | -| **repositories** | [**List**](Repository.md) | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | -| **totalCount** | **Integer** | | [optional] [default to null] | -| **pagePerIntegration** | **Integer** | | [optional] [default to null] | -| **sizePerIntegration** | **Integer** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **repositories** | [**List**](Repository.md) | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | +| **totalCount** | **Integer** | | [optional] [default to null] | +| **pagePerIntegration** | **Integer** | | [optional] [default to null] | +| **sizePerIntegration** | **Integer** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository_importStatus.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository_importStatus.md index e011905ce5..e5bb131048 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository_importStatus.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Repository_importStatus.md @@ -1,8 +1,8 @@ # Repository_importStatus - ## Properties | Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +|------------ | ------------- | ------------- | -------------| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ScaffolderTask.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ScaffolderTask.md index 291f5b7ca7..0b2119abb3 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ScaffolderTask.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ScaffolderTask.md @@ -1,11 +1,11 @@ # ScaffolderTask - ## Properties -| Name | Type | Description | Notes | -| ---------------- | -------------- | ----------- | ---------------------------- | -| **taskId** | **String** | | [optional] [default to null] | -| **repositoryId** | **BigDecimal** | | [optional] [default to null] | -| **locations** | **List** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **taskId** | **String** | | [optional] [default to null] | +| **repositoryId** | **BigDecimal** | | [optional] [default to null] | +| **locations** | **List** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Source.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Source.md index 60202d2266..b7d550c850 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Source.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Source.md @@ -1,8 +1,8 @@ # Source - ## Properties | Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +|------------ | ------------- | ------------- | -------------| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/SourceImport.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/SourceImport.md index 0fccafad4e..e5555c84ce 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/SourceImport.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/SourceImport.md @@ -1,20 +1,20 @@ # SourceImport - ## Properties -| Name | Type | Description | Notes | -| --------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------- | -| **id** | **String** | | [optional] [default to null] | -| **status** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] | -| **task** | [**Import_task**](Import_task.md) | | [optional] [default to null] | -| **tasks** | [**List**](Import_task.md) | | [optional] [default to null] | -| **catalogEntityName** | **String** | Specified entity name in the catalog. Filled only in response for dry-run import requests. | [optional] [default to null] | -| **lastUpdate** | **Date** | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | -| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] | -| **repository** | [**Repository**](Repository.md) | | [optional] [default to null] | -| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] | -| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] | -| **source** | [**Source**](Source.md) | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **id** | **String** | | [optional] [default to null] | +| **status** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] | +| **task** | [**Import_task**](Import_task.md) | | [optional] [default to null] | +| **tasks** | [**List**](Import_task.md) | | [optional] [default to null] | +| **catalogEntityName** | **String** | Specified entity name in the catalog. Filled only in response for dry-run import requests. | [optional] [default to null] | +| **lastUpdate** | **Date** | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | +| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] | +| **repository** | [**Repository**](Repository.md) | | [optional] [default to null] | +| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] | +| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] | +| **source** | [**Source**](Source.md) | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/TaskImportStatus.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/TaskImportStatus.md index a583cac6d1..60dd9e9455 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/TaskImportStatus.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/TaskImportStatus.md @@ -1,8 +1,8 @@ # TaskImportStatus - ## Properties | Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +|------------ | ------------- | ------------- | -------------| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_200_response.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_200_response.md index 3877813197..3eab18be44 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_200_response.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_200_response.md @@ -1,13 +1,13 @@ # findAllImports_200_response - ## Properties -| Name | Type | Description | Notes | -| -------------- | --------------------------- | ----------- | ---------------------------- | -| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | -| **totalCount** | **Integer** | | [optional] [default to null] | -| **page** | **Integer** | | [optional] [default to null] | -| **size** | **Integer** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | +| **totalCount** | **Integer** | | [optional] [default to null] | +| **page** | **Integer** | | [optional] [default to null] | +| **size** | **Integer** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_500_response.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_500_response.md index c4ef1e23ef..b64903fe82 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_500_response.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/findAllImports_500_response.md @@ -1,13 +1,13 @@ # findAllImports_500_response - ## Properties -| Name | Type | Description | Notes | -| -------------- | --------------------------- | ----------- | ---------------------------- | -| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] | -| **errors** | **List** | | [optional] [default to null] | -| **totalCount** | **Integer** | | [optional] [default to null] | -| **page** | **Integer** | | [optional] [default to null] | -| **size** | **Integer** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] | +| **errors** | **List** | | [optional] [default to null] | +| **totalCount** | **Integer** | | [optional] [default to null] | +| **page** | **Integer** | | [optional] [default to null] | +| **size** | **Integer** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ping_200_response.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ping_200_response.md index 2f59f1fe0c..98a014b1b7 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ping_200_response.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ping_200_response.md @@ -1,9 +1,9 @@ # ping_200_response - ## Properties -| Name | Type | Description | Notes | -| ---------- | ---------- | ----------- | ---------------------------- | -| **status** | **String** | | [optional] [default to null] | +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **status** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/README.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/README.md index ecf067769d..62b9db61f7 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/README.md +++ b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/README.md @@ -1,59 +1,58 @@ # Documentation for Bulk Import Backend - ## Documentation for API Endpoints -All URIs are relative to _http://localhost:7007/api/bulk-import_ - -| Class | Method | HTTP request | Description | -| ----------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | -| _ImportApi_ | [**createImportJobs**](Apis/ImportApi.md#createimportjobs) | **POST** /imports | Submit Import Jobs | -| _ImportApi_ | [**createTaskImportJobs**](Apis/ImportApi.md#createtaskimportjobs) | **POST** /task-imports | Execute a scaffolder template for a list of repositories | -| _ImportApi_ | [**deleteImportByRepo**](Apis/ImportApi.md#deleteimportbyrepo) | **DELETE** /import/by-repo | Delete Import by repository | -| _ImportApi_ | [**deleteTaskImportByRepo**](Apis/ImportApi.md#deletetaskimportbyrepo) | **DELETE** /task-import/by-repo | Delete stored scaffolder task records for a specific repository | -| _ImportApi_ | [**findAllImports**](Apis/ImportApi.md#findallimports) | **GET** /imports | Fetch Import Jobs | -| _ImportApi_ | [**findAllTaskImports**](Apis/ImportApi.md#findalltaskimports) | **GET** /task-imports | Fetch Import Jobs | -| _ImportApi_ | [**findImportStatusByRepo**](Apis/ImportApi.md#findimportstatusbyrepo) | **GET** /import/by-repo | Get Import Status by repository | -| _ImportApi_ | [**findTaskImportStatusByRepo**](Apis/ImportApi.md#findtaskimportstatusbyrepo) | **GET** /task-import/by-repo | Get Import Status by repository | -| _ManagementApi_ | [**ping**](Apis/ManagementApi.md#ping) | **GET** /ping | Check the health of the Bulk Import backend router | -| _OrganizationApi_ | [**findAllOrganizations**](Apis/OrganizationApi.md#findallorganizations) | **GET** /organizations | Fetch Organizations accessible by Backstage Github Integrations | -| _OrganizationApi_ | [**findRepositoriesByOrganization**](Apis/OrganizationApi.md#findrepositoriesbyorganization) | **GET** /organizations/{organizationName}/repositories | Fetch Repositories in the specified GitHub organization, provided it is accessible by any of the configured GitHub Integrations. | -| _RepositoryApi_ | [**findAllRepositories**](Apis/RepositoryApi.md#findallrepositories) | **GET** /repositories | Fetch Organization Repositories accessible by Backstage Github Integrations | +All URIs are relative to *http://localhost:7007/api/bulk-import* - +| Class | Method | HTTP request | Description | +|------------ | ------------- | ------------- | -------------| +| *ImportApi* | [**createImportJobs**](Apis/ImportApi.md#createimportjobs) | **POST** /imports | Submit Import Jobs | +*ImportApi* | [**createTaskImportJobs**](Apis/ImportApi.md#createtaskimportjobs) | **POST** /task-imports | Execute a scaffolder template for a list of repositories | +*ImportApi* | [**deleteImportByRepo**](Apis/ImportApi.md#deleteimportbyrepo) | **DELETE** /import/by-repo | Delete Import by repository | +*ImportApi* | [**deleteTaskImportByRepo**](Apis/ImportApi.md#deletetaskimportbyrepo) | **DELETE** /task-import/by-repo | Delete stored scaffolder task records for a specific repository | +*ImportApi* | [**findAllImports**](Apis/ImportApi.md#findallimports) | **GET** /imports | Fetch Import Jobs | +*ImportApi* | [**findAllTaskImports**](Apis/ImportApi.md#findalltaskimports) | **GET** /task-imports | Fetch Import Jobs | +*ImportApi* | [**findImportStatusByRepo**](Apis/ImportApi.md#findimportstatusbyrepo) | **GET** /import/by-repo | Get Import Status by repository | +*ImportApi* | [**findTaskImportStatusByRepo**](Apis/ImportApi.md#findtaskimportstatusbyrepo) | **GET** /task-import/by-repo | Get Import Status by repository | +| *ManagementApi* | [**ping**](Apis/ManagementApi.md#ping) | **GET** /ping | Check the health of the Bulk Import backend router | +| *OrganizationApi* | [**findAllOrganizations**](Apis/OrganizationApi.md#findallorganizations) | **GET** /organizations | Fetch Organizations accessible by Backstage Github Integrations | +*OrganizationApi* | [**findRepositoriesByOrganization**](Apis/OrganizationApi.md#findrepositoriesbyorganization) | **GET** /organizations/{organizationName}/repositories | Fetch Repositories in the specified GitHub organization, provided it is accessible by any of the configured GitHub Integrations. | +| *RepositoryApi* | [**findAllRepositories**](Apis/RepositoryApi.md#findallrepositories) | **GET** /repositories | Fetch Organization Repositories accessible by Backstage Github Integrations | + + ## Documentation for Models -- [ApprovalTool](./Models/ApprovalTool.md) -- [Import](./Models/Import.md) -- [ImportJobListV2](./Models/ImportJobListV2.md) -- [ImportRequest](./Models/ImportRequest.md) -- [ImportRequest_repository](./Models/ImportRequest_repository.md) -- [ImportStatus](./Models/ImportStatus.md) -- [Import_github](./Models/Import_github.md) -- [Import_gitlab](./Models/Import_gitlab.md) -- [Import_task](./Models/Import_task.md) -- [Organization](./Models/Organization.md) -- [OrganizationList](./Models/OrganizationList.md) -- [PullRequest](./Models/PullRequest.md) -- [Repository](./Models/Repository.md) -- [RepositoryList](./Models/RepositoryList.md) -- [Repository_importStatus](./Models/Repository_importStatus.md) -- [ScaffolderTask](./Models/ScaffolderTask.md) -- [Source](./Models/Source.md) -- [SourceImport](./Models/SourceImport.md) -- [TaskImportStatus](./Models/TaskImportStatus.md) -- [findAllImports_200_response](./Models/findAllImports_200_response.md) -- [findAllImports_500_response](./Models/findAllImports_500_response.md) -- [ping_200_response](./Models/ping_200_response.md) + - [ApprovalTool](./Models/ApprovalTool.md) + - [Import](./Models/Import.md) + - [ImportJobListV2](./Models/ImportJobListV2.md) + - [ImportRequest](./Models/ImportRequest.md) + - [ImportRequest_repository](./Models/ImportRequest_repository.md) + - [ImportStatus](./Models/ImportStatus.md) + - [Import_github](./Models/Import_github.md) + - [Import_gitlab](./Models/Import_gitlab.md) + - [Import_task](./Models/Import_task.md) + - [Organization](./Models/Organization.md) + - [OrganizationList](./Models/OrganizationList.md) + - [PullRequest](./Models/PullRequest.md) + - [Repository](./Models/Repository.md) + - [RepositoryList](./Models/RepositoryList.md) + - [Repository_importStatus](./Models/Repository_importStatus.md) + - [ScaffolderTask](./Models/ScaffolderTask.md) + - [Source](./Models/Source.md) + - [SourceImport](./Models/SourceImport.md) + - [TaskImportStatus](./Models/TaskImportStatus.md) + - [findAllImports_200_response](./Models/findAllImports_200_response.md) + - [findAllImports_500_response](./Models/findAllImports_500_response.md) + - [ping_200_response](./Models/ping_200_response.md) - + ## Documentation for Authorization - ### BearerAuth - **Type**: HTTP Bearer Token authentication (JWT) + diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/package.json b/workspaces/bulk-import/plugins/bulk-import-backend/package.json index 1b61e82e93..6eb638b384 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/package.json +++ b/workspaces/bulk-import/plugins/bulk-import-backend/package.json @@ -83,7 +83,7 @@ "js-yaml-cli": "0.6.0", "msw": "1.3.5", "openapicmd": "2.7.0", - "prettier": "3.6.2", + "prettier": "3.7.4", "supertest": "6.3.4" }, "peerDependencies": { diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapi.d.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapi.d.ts index 7650e5841c..827be8aa25 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapi.d.ts +++ b/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapi.d.ts @@ -2,549 +2,519 @@ // eslint-disable // prettier-ignore -import type { OpenAPIClient, Parameters, UnknownParamsObject, OperationResponse, AxiosRequestConfig } from 'openapi-client-axios'; +import type { + OpenAPIClient, + Parameters, + UnknownParamsObject, + OperationResponse, + AxiosRequestConfig, +} from 'openapi-client-axios'; declare namespace Components { - export interface HeaderParameters { - apiVersionHeaderParam?: Parameters.ApiVersionHeaderParam; - } - namespace Parameters { - export type ApiVersionHeaderParam = 'v1' | 'v2'; - export type ApprovalToolParam = string; - export type PagePerIntegrationQueryParam = number; - export type PagePerIntegrationQueryParamDeprecated = number; - export type PageQueryParam = number; - export type SearchQueryParam = string; - export type SizePerIntegrationQueryParam = number; - export type SizePerIntegrationQueryParamDeprecated = number; - export type SizeQueryParam = number; - export type SortColumnQueryParam = - | 'repository.name' - | 'repository.organization' - | 'repository.url' - | 'lastUpdate' - | 'status'; - export type SortOrderQueryParam = 'asc' | 'desc'; - } - export interface QueryParameters { - pagePerIntegrationQueryParam?: Parameters.PagePerIntegrationQueryParam; - sizePerIntegrationQueryParam?: Parameters.SizePerIntegrationQueryParam; - pagePerIntegrationQueryParamDeprecated?: Parameters.PagePerIntegrationQueryParamDeprecated; - sortColumnQueryParam?: Parameters.SortColumnQueryParam; - sortOrderQueryParam?: Parameters.SortOrderQueryParam; - sizePerIntegrationQueryParamDeprecated?: Parameters.SizePerIntegrationQueryParamDeprecated; - searchQueryParam?: Parameters.SearchQueryParam; - pageQueryParam?: Parameters.PageQueryParam; - sizeQueryParam?: Parameters.SizeQueryParam; - approvalToolParam?: Parameters.ApprovalToolParam; - } - namespace Schemas { - export type ApprovalTool = 'GIT' | 'SERVICENOW' | 'GITLAB'; - /** - * Import Job - */ - export interface Import { - id?: string; - status?: /* Import Job status */ - ImportStatus | /* Import Job status */ TaskImportStatus; - task?: { - taskId?: string; - }; - tasks?: { - taskId?: string; - }[]; - /** - * Specified entity name in the catalog. Filled only in response for dry-run import requests. - */ - catalogEntityName?: string; - lastUpdate?: string; // date-time - errors?: string[]; - approvalTool?: ApprovalTool; - repository?: /* Repository */ Repository; - /** - * GitLab details. Applicable if approvalTool is gitlab. - */ - gitlab?: { - pullRequest?: PullRequest; - }; - /** - * GitHub details. Applicable if approvalTool is git. - */ - github?: { - pullRequest?: PullRequest; - }; + export interface HeaderParameters { + apiVersionHeaderParam?: Parameters.ApiVersionHeaderParam; } - /** - * Import Job List - */ - export interface ImportJobListV2 { - imports?: /* Import Job with source it originates from */ SourceImport[]; - errors?: string[]; - totalCount?: number; - page?: number; - size?: number; + namespace Parameters { + export type ApiVersionHeaderParam = "v1" | "v2"; + export type ApprovalToolParam = string; + export type PagePerIntegrationQueryParam = number; + export type PagePerIntegrationQueryParamDeprecated = number; + export type PageQueryParam = number; + export type SearchQueryParam = string; + export type SizePerIntegrationQueryParam = number; + export type SizePerIntegrationQueryParamDeprecated = number; + export type SizeQueryParam = number; + export type SortColumnQueryParam = "repository.name" | "repository.organization" | "repository.url" | "lastUpdate" | "status"; + export type SortOrderQueryParam = "asc" | "desc"; } - /** - * Import Job request - */ - export interface ImportRequest { - approvalTool?: ApprovalTool; - /** - * Expected Entity name in the catalog. Relevant only if the 'dryRun' query parameter is set to 'true'. - */ - catalogEntityName?: string; - /** - * Whether the CODEOWNERS file will be used as entity owner. Only relevant for dry-run requests. If set to 'false', the corresponding dry-run check will be skipped. - */ - codeOwnersFileAsEntityOwner?: boolean; - repository: { + export interface QueryParameters { + pagePerIntegrationQueryParam?: Parameters.PagePerIntegrationQueryParam; + sizePerIntegrationQueryParam?: Parameters.SizePerIntegrationQueryParam; + pagePerIntegrationQueryParamDeprecated?: Parameters.PagePerIntegrationQueryParamDeprecated; + sortColumnQueryParam?: Parameters.SortColumnQueryParam; + sortOrderQueryParam?: Parameters.SortOrderQueryParam; + sizePerIntegrationQueryParamDeprecated?: Parameters.SizePerIntegrationQueryParamDeprecated; + searchQueryParam?: Parameters.SearchQueryParam; + pageQueryParam?: Parameters.PageQueryParam; + sizeQueryParam?: Parameters.SizeQueryParam; + approvalToolParam?: Parameters.ApprovalToolParam; + } + namespace Schemas { + export type ApprovalTool = "GIT" | "SERVICENOW" | "GITLAB"; /** - * repository name + * Import Job */ - name?: string; + export interface Import { + id?: string; + status?: /* Import Job status */ ImportStatus | /* Import Job status */ TaskImportStatus; + task?: { + taskId?: string; + }; + tasks?: { + taskId?: string; + }[]; + /** + * Specified entity name in the catalog. Filled only in response for dry-run import requests. + */ + catalogEntityName?: string; + lastUpdate?: string; // date-time + errors?: string[]; + approvalTool?: ApprovalTool; + repository?: /* Repository */ Repository; + /** + * GitLab details. Applicable if approvalTool is gitlab. + */ + gitlab?: { + pullRequest?: PullRequest; + }; + /** + * GitHub details. Applicable if approvalTool is git. + */ + github?: { + pullRequest?: PullRequest; + }; + } /** - * repository URL + * Import Job List */ - url: string; + export interface ImportJobListV2 { + imports?: /* Import Job with source it originates from */ SourceImport[]; + errors?: string[]; + totalCount?: number; + page?: number; + size?: number; + } /** - * organization which the repository is part of + * Import Job request */ - organization?: string; + export interface ImportRequest { + approvalTool?: ApprovalTool; + /** + * Expected Entity name in the catalog. Relevant only if the 'dryRun' query parameter is set to 'true'. + */ + catalogEntityName?: string; + /** + * Whether the CODEOWNERS file will be used as entity owner. Only relevant for dry-run requests. If set to 'false', the corresponding dry-run check will be skipped. + */ + codeOwnersFileAsEntityOwner?: boolean; + repository: { + /** + * repository name + */ + name?: string; + /** + * repository URL + */ + url: string; + /** + * organization which the repository is part of + */ + organization?: string; + /** + * default branch + */ + defaultBranch?: string; + }; + /** + * content of the catalog-info.yaml to include in the import Pull Request. + */ + catalogInfoContent?: string; + /** + * GitLab details. Applicable if approvalTool is gitlab. + */ + gitlab?: { + pullRequest?: PullRequest; + }; + /** + * GitHub details. Applicable if approvalTool is git. + */ + github?: { + pullRequest?: PullRequest; + }; + } /** - * default branch + * Import Job status */ - defaultBranch?: string; - }; - /** - * content of the catalog-info.yaml to include in the import Pull Request. - */ - catalogInfoContent?: string; - /** - * GitLab details. Applicable if approvalTool is gitlab. - */ - gitlab?: { - pullRequest?: PullRequest; - }; - /** - * GitHub details. Applicable if approvalTool is git. - */ - github?: { - pullRequest?: PullRequest; - }; - } - /** - * Import Job status - */ - export type ImportStatus = 'ADDED' | 'WAIT_PR_APPROVAL' | 'PR_ERROR' | null; - /** - * Organization - */ - export interface Organization { - /** - * unique identifier - */ - id?: string; - /** - * organization name - */ - name?: string; - /** - * organization description - */ - description?: string; - /** - * organization URL - */ - url?: string; - /** - * total number of repositories in this Organization - */ - totalRepoCount?: number; - errors?: string[]; - } - /** - * Organization List - */ - export interface OrganizationList { - organizations?: /* Organization */ Organization[]; - errors?: string[]; - totalCount?: number; - pagePerIntegration?: number; - sizePerIntegration?: number; - } - export interface PullRequest { - /** - * URL of the Pull Request - */ - url?: string; - /** - * Pull Request number - */ - number?: number; - /** - * title of the Pull Request - */ - title?: string; - /** - * body of the Pull Request - */ - body?: string; - /** - * content of the catalog-info.yaml as fetched from the Pull Request. - */ - catalogInfoContent?: string; - status?: 'WAIT_PR_APPROVAL' | 'PR_MERGED' | 'PR_ERROR'; - } - /** - * Repository - */ - export interface Repository { - /** - * unique identifier - */ - id?: string; - /** - * repository name - */ - name?: string; - /** - * repository URL - */ - url?: string; - /** - * organization which the repository is part of - */ - organization?: string; - importStatus?: /* Import Job status */ - ImportStatus | /* Import Job status */ TaskImportStatus; - /** - * default branch - */ - defaultBranch?: string; - lastUpdate?: string; // date-time - errors?: string[]; - } - /** - * Repository List - */ - export interface RepositoryList { - repositories?: /* Repository */ Repository[]; - errors?: string[]; - totalCount?: number; - pagePerIntegration?: number; - sizePerIntegration?: number; - } - /** - * Scaffolder Task - */ - export interface ScaffolderTask { - taskId?: string; - repositoryId?: number; - locations?: string[]; - } - /** - * Import Source: - * * 'config' - Import from static catalog location configuration in 'app-config' - * * 'location' - Import of user registered entities using locations endpoint - * * 'integration' - Import using a GitHub integration - * * null - Import source is unknown - * - */ - export type Source = 'config' | 'location' | 'integration' | null; - /** - * Import Job with source it originates from - */ - export interface SourceImport { - id?: string; - status?: /* Import Job status */ - ImportStatus | /* Import Job status */ TaskImportStatus; - task?: { - taskId?: string; - }; - tasks?: { - taskId?: string; - }[]; - /** - * Specified entity name in the catalog. Filled only in response for dry-run import requests. - */ - catalogEntityName?: string; - lastUpdate?: string; // date-time - errors?: string[]; - approvalTool?: ApprovalTool; - repository?: /* Repository */ Repository; - /** - * GitLab details. Applicable if approvalTool is gitlab. - */ - gitlab?: { - pullRequest?: PullRequest; - }; - /** - * GitHub details. Applicable if approvalTool is git. - */ - github?: { - pullRequest?: PullRequest; - }; - source?: /** - * Import Source: - * * 'config' - Import from static catalog location configuration in 'app-config' - * * 'location' - Import of user registered entities using locations endpoint - * * 'integration' - Import using a GitHub integration - * * null - Import source is unknown - * - */ - Source; + export type ImportStatus = "ADDED" | "WAIT_PR_APPROVAL" | "PR_ERROR" | null; + /** + * Organization + */ + export interface Organization { + /** + * unique identifier + */ + id?: string; + /** + * organization name + */ + name?: string; + /** + * organization description + */ + description?: string; + /** + * organization URL + */ + url?: string; + /** + * total number of repositories in this Organization + */ + totalRepoCount?: number; + errors?: string[]; + } + /** + * Organization List + */ + export interface OrganizationList { + organizations?: /* Organization */ Organization[]; + errors?: string[]; + totalCount?: number; + pagePerIntegration?: number; + sizePerIntegration?: number; + } + export interface PullRequest { + /** + * URL of the Pull Request + */ + url?: string; + /** + * Pull Request number + */ + number?: number; + /** + * title of the Pull Request + */ + title?: string; + /** + * body of the Pull Request + */ + body?: string; + /** + * content of the catalog-info.yaml as fetched from the Pull Request. + */ + catalogInfoContent?: string; + status?: "WAIT_PR_APPROVAL" | "PR_MERGED" | "PR_ERROR"; + } + /** + * Repository + */ + export interface Repository { + /** + * unique identifier + */ + id?: string; + /** + * repository name + */ + name?: string; + /** + * repository URL + */ + url?: string; + /** + * organization which the repository is part of + */ + organization?: string; + importStatus?: /* Import Job status */ ImportStatus | /* Import Job status */ TaskImportStatus; + /** + * default branch + */ + defaultBranch?: string; + lastUpdate?: string; // date-time + errors?: string[]; + } + /** + * Repository List + */ + export interface RepositoryList { + repositories?: /* Repository */ Repository[]; + errors?: string[]; + totalCount?: number; + pagePerIntegration?: number; + sizePerIntegration?: number; + } + /** + * Scaffolder Task + */ + export interface ScaffolderTask { + taskId?: string; + repositoryId?: number; + locations?: string[]; + } + /** + * Import Source: + * * 'config' - Import from static catalog location configuration in 'app-config' + * * 'location' - Import of user registered entities using locations endpoint + * * 'integration' - Import using a GitHub integration + * * null - Import source is unknown + * + */ + export type Source = "config" | "location" | "integration" | null; + /** + * Import Job with source it originates from + */ + export interface SourceImport { + id?: string; + status?: /* Import Job status */ ImportStatus | /* Import Job status */ TaskImportStatus; + task?: { + taskId?: string; + }; + tasks?: { + taskId?: string; + }[]; + /** + * Specified entity name in the catalog. Filled only in response for dry-run import requests. + */ + catalogEntityName?: string; + lastUpdate?: string; // date-time + errors?: string[]; + approvalTool?: ApprovalTool; + repository?: /* Repository */ Repository; + /** + * GitLab details. Applicable if approvalTool is gitlab. + */ + gitlab?: { + pullRequest?: PullRequest; + }; + /** + * GitHub details. Applicable if approvalTool is git. + */ + github?: { + pullRequest?: PullRequest; + }; + source?: /** + * Import Source: + * * 'config' - Import from static catalog location configuration in 'app-config' + * * 'location' - Import of user registered entities using locations endpoint + * * 'integration' - Import using a GitHub integration + * * null - Import source is unknown + * + */ + Source; + } + /** + * Import Job status + */ + export type TaskImportStatus = "TASK_CANCELLED" | "TASK_COMPLETED" | "TASK_FAILED" | "TASK_OPEN" | "TASK_PROCESSING" | "TASK_SKIPPED" | "TASK_FETCH_FAILED"; } - /** - * Import Job status - */ - export type TaskImportStatus = - | 'TASK_CANCELLED' - | 'TASK_COMPLETED' - | 'TASK_FAILED' - | 'TASK_OPEN' - | 'TASK_PROCESSING' - | 'TASK_SKIPPED' - | 'TASK_FETCH_FAILED'; - } } declare namespace Paths { - namespace CreateImportJobs { - namespace Parameters { - export type DryRun = boolean; - } - export interface QueryParameters { - dryRun?: Parameters.DryRun; - } - export type RequestBody = - /* Import Job request */ Components.Schemas.ImportRequest[]; - namespace Responses { - export type $202 = /* Import Job */ Components.Schemas.Import[]; - } - } - namespace CreateTaskImportJobs { - export type RequestBody = - /* Import Job request */ Components.Schemas.ImportRequest[]; - namespace Responses { - export type $202 = /* Import Job */ Components.Schemas.Import[]; - } - } - namespace DeleteImportByRepo { - namespace Parameters { - export type ApprovalTool = string; - export type DefaultBranch = string; - export type Repo = string; - } - export interface QueryParameters { - repo?: Parameters.Repo; - defaultBranch?: Parameters.DefaultBranch; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export interface $204 {} - export interface $500 {} + namespace CreateImportJobs { + namespace Parameters { + export type DryRun = boolean; + } + export interface QueryParameters { + dryRun?: Parameters.DryRun; + } + export type RequestBody = /* Import Job request */ Components.Schemas.ImportRequest[]; + namespace Responses { + export type $202 = /* Import Job */ Components.Schemas.Import[]; + } + } + namespace CreateTaskImportJobs { + export type RequestBody = /* Import Job request */ Components.Schemas.ImportRequest[]; + namespace Responses { + export type $202 = /* Import Job */ Components.Schemas.Import[]; + } + } + namespace DeleteImportByRepo { + namespace Parameters { + export type ApprovalTool = string; + export type DefaultBranch = string; + export type Repo = string; + } + export interface QueryParameters { + repo?: Parameters.Repo; + defaultBranch?: Parameters.DefaultBranch; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export interface $204 { + } + export interface $500 { + } + } + } + namespace DeleteTaskImportByRepo { + namespace Parameters { + export type ApprovalTool = string; + export type Repo = string; + } + export interface QueryParameters { + repo?: Parameters.Repo; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export interface $204 { + } + export interface $500 { + } + } + } + namespace FindAllImports { + export interface HeaderParameters { + "api-version"?: Parameters.ApiVersion; + } + namespace Parameters { + export type ApiVersion = "v1" | "v2"; + export type ApprovalTool = string; + export type Page = number; + export type PagePerIntegration = number; + export type Search = string; + export type Size = number; + export type SizePerIntegration = number; + export type SortColumn = "repository.name" | "repository.organization" | "repository.url" | "lastUpdate" | "status"; + export type SortOrder = "asc" | "desc"; + } + export interface QueryParameters { + pagePerIntegration?: Parameters.PagePerIntegration; + sizePerIntegration?: Parameters.SizePerIntegration; + page?: Parameters.Page; + size?: Parameters.Size; + sortOrder?: Parameters.SortOrder; + sortColumn?: Parameters.SortColumn; + search?: Parameters.Search; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export type $200 = /* Import Job with source it originates from */ Components.Schemas.SourceImport[] | /* Import Job List */ Components.Schemas.ImportJobListV2; + export type $500 = string | /* Import Job List */ Components.Schemas.ImportJobListV2; + } + } + namespace FindAllOrganizations { + namespace Parameters { + export type ApprovalTool = string; + export type PagePerIntegration = number; + export type Search = string; + export type SizePerIntegration = number; + } + export interface QueryParameters { + pagePerIntegration?: Parameters.PagePerIntegration; + sizePerIntegration?: Parameters.SizePerIntegration; + search?: Parameters.Search; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export type $200 = /* Organization List */ Components.Schemas.OrganizationList; + export type $500 = /* Organization List */ Components.Schemas.OrganizationList; + } + } + namespace FindAllRepositories { + namespace Parameters { + export type ApprovalTool = string; + export type CheckImportStatus = boolean; + export type PagePerIntegration = number; + export type Search = string; + export type SizePerIntegration = number; + } + export interface QueryParameters { + checkImportStatus?: Parameters.CheckImportStatus; + pagePerIntegration?: Parameters.PagePerIntegration; + sizePerIntegration?: Parameters.SizePerIntegration; + search?: Parameters.Search; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export type $200 = /* Repository List */ Components.Schemas.RepositoryList; + export type $500 = /* Repository List */ Components.Schemas.RepositoryList; + } + } + namespace FindAllTaskImports { + export interface HeaderParameters { + "api-version"?: Parameters.ApiVersion; + } + namespace Parameters { + export type ApiVersion = "v1" | "v2"; + export type Page = number; + export type PagePerIntegration = number; + export type Search = string; + export type Size = number; + export type SizePerIntegration = number; + export type SortColumn = "repository.name" | "repository.organization" | "repository.url" | "lastUpdate" | "status"; + export type SortOrder = "asc" | "desc"; + } + export interface QueryParameters { + pagePerIntegration?: Parameters.PagePerIntegration; + sizePerIntegration?: Parameters.SizePerIntegration; + page?: Parameters.Page; + size?: Parameters.Size; + sortOrder?: Parameters.SortOrder; + sortColumn?: Parameters.SortColumn; + search?: Parameters.Search; + } + namespace Responses { + export type $200 = /* Import Job with source it originates from */ Components.Schemas.SourceImport[] | /* Import Job List */ Components.Schemas.ImportJobListV2; + export type $500 = string | /* Import Job List */ Components.Schemas.ImportJobListV2; + } + } + namespace FindImportStatusByRepo { + namespace Parameters { + export type ApprovalTool = string; + export type DefaultBranch = string; + export type Repo = string; + } + export interface QueryParameters { + repo?: Parameters.Repo; + defaultBranch?: Parameters.DefaultBranch; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export type $200 = /* Import Job */ Components.Schemas.Import; + export interface $500 { + } + } + } + namespace FindRepositoriesByOrganization { + namespace Parameters { + export type ApprovalTool = string; + export type CheckImportStatus = boolean; + export type OrganizationName = string; + export type PagePerIntegration = number; + export type Search = string; + export type SizePerIntegration = number; + } + export interface PathParameters { + organizationName: Parameters.OrganizationName; + } + export interface QueryParameters { + checkImportStatus?: Parameters.CheckImportStatus; + pagePerIntegration?: Parameters.PagePerIntegration; + sizePerIntegration?: Parameters.SizePerIntegration; + search?: Parameters.Search; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export type $200 = /* Repository List */ Components.Schemas.RepositoryList; + export type $500 = /* Repository List */ Components.Schemas.RepositoryList; + } + } + namespace FindTaskImportStatusByRepo { + namespace Parameters { + export type ApprovalTool = string; + export type DefaultBranch = string; + export type Repo = string; + } + export interface QueryParameters { + repo?: Parameters.Repo; + defaultBranch?: Parameters.DefaultBranch; + approvalTool?: Parameters.ApprovalTool; + } + namespace Responses { + export type $200 = /* Import Job */ Components.Schemas.Import; + export interface $500 { + } + } + } + namespace Ping { + namespace Responses { + export interface $200 { + status?: "ok"; + } + } } - } - namespace DeleteTaskImportByRepo { - namespace Parameters { - export type ApprovalTool = string; - export type Repo = string; - } - export interface QueryParameters { - repo?: Parameters.Repo; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export interface $204 {} - export interface $500 {} - } - } - namespace FindAllImports { - export interface HeaderParameters { - 'api-version'?: Parameters.ApiVersion; - } - namespace Parameters { - export type ApiVersion = 'v1' | 'v2'; - export type ApprovalTool = string; - export type Page = number; - export type PagePerIntegration = number; - export type Search = string; - export type Size = number; - export type SizePerIntegration = number; - export type SortColumn = - | 'repository.name' - | 'repository.organization' - | 'repository.url' - | 'lastUpdate' - | 'status'; - export type SortOrder = 'asc' | 'desc'; - } - export interface QueryParameters { - pagePerIntegration?: Parameters.PagePerIntegration; - sizePerIntegration?: Parameters.SizePerIntegration; - page?: Parameters.Page; - size?: Parameters.Size; - sortOrder?: Parameters.SortOrder; - sortColumn?: Parameters.SortColumn; - search?: Parameters.Search; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export type $200 = - /* Import Job with source it originates from */ - | Components.Schemas.SourceImport[] - | /* Import Job List */ Components.Schemas.ImportJobListV2; - export type $500 = - | string - | /* Import Job List */ Components.Schemas.ImportJobListV2; - } - } - namespace FindAllOrganizations { - namespace Parameters { - export type ApprovalTool = string; - export type PagePerIntegration = number; - export type Search = string; - export type SizePerIntegration = number; - } - export interface QueryParameters { - pagePerIntegration?: Parameters.PagePerIntegration; - sizePerIntegration?: Parameters.SizePerIntegration; - search?: Parameters.Search; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export type $200 = - /* Organization List */ Components.Schemas.OrganizationList; - export type $500 = - /* Organization List */ Components.Schemas.OrganizationList; - } - } - namespace FindAllRepositories { - namespace Parameters { - export type ApprovalTool = string; - export type CheckImportStatus = boolean; - export type PagePerIntegration = number; - export type Search = string; - export type SizePerIntegration = number; - } - export interface QueryParameters { - checkImportStatus?: Parameters.CheckImportStatus; - pagePerIntegration?: Parameters.PagePerIntegration; - sizePerIntegration?: Parameters.SizePerIntegration; - search?: Parameters.Search; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export type $200 = - /* Repository List */ Components.Schemas.RepositoryList; - export type $500 = - /* Repository List */ Components.Schemas.RepositoryList; - } - } - namespace FindAllTaskImports { - export interface HeaderParameters { - 'api-version'?: Parameters.ApiVersion; - } - namespace Parameters { - export type ApiVersion = 'v1' | 'v2'; - export type Page = number; - export type PagePerIntegration = number; - export type Search = string; - export type Size = number; - export type SizePerIntegration = number; - export type SortColumn = - | 'repository.name' - | 'repository.organization' - | 'repository.url' - | 'lastUpdate' - | 'status'; - export type SortOrder = 'asc' | 'desc'; - } - export interface QueryParameters { - pagePerIntegration?: Parameters.PagePerIntegration; - sizePerIntegration?: Parameters.SizePerIntegration; - page?: Parameters.Page; - size?: Parameters.Size; - sortOrder?: Parameters.SortOrder; - sortColumn?: Parameters.SortColumn; - search?: Parameters.Search; - } - namespace Responses { - export type $200 = - /* Import Job with source it originates from */ - | Components.Schemas.SourceImport[] - | /* Import Job List */ Components.Schemas.ImportJobListV2; - export type $500 = - | string - | /* Import Job List */ Components.Schemas.ImportJobListV2; - } - } - namespace FindImportStatusByRepo { - namespace Parameters { - export type ApprovalTool = string; - export type DefaultBranch = string; - export type Repo = string; - } - export interface QueryParameters { - repo?: Parameters.Repo; - defaultBranch?: Parameters.DefaultBranch; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export type $200 = /* Import Job */ Components.Schemas.Import; - export interface $500 {} - } - } - namespace FindRepositoriesByOrganization { - namespace Parameters { - export type ApprovalTool = string; - export type CheckImportStatus = boolean; - export type OrganizationName = string; - export type PagePerIntegration = number; - export type Search = string; - export type SizePerIntegration = number; - } - export interface PathParameters { - organizationName: Parameters.OrganizationName; - } - export interface QueryParameters { - checkImportStatus?: Parameters.CheckImportStatus; - pagePerIntegration?: Parameters.PagePerIntegration; - sizePerIntegration?: Parameters.SizePerIntegration; - search?: Parameters.Search; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export type $200 = - /* Repository List */ Components.Schemas.RepositoryList; - export type $500 = - /* Repository List */ Components.Schemas.RepositoryList; - } - } - namespace FindTaskImportStatusByRepo { - namespace Parameters { - export type ApprovalTool = string; - export type DefaultBranch = string; - export type Repo = string; - } - export interface QueryParameters { - repo?: Parameters.Repo; - defaultBranch?: Parameters.DefaultBranch; - approvalTool?: Parameters.ApprovalTool; - } - namespace Responses { - export type $200 = /* Import Job */ Components.Schemas.Import; - export interface $500 {} - } - } - namespace Ping { - namespace Responses { - export interface $200 { - status?: 'ok'; - } - } - } } + export interface OperationMethods { /** * ping - Check the health of the Bulk Import backend router @@ -552,105 +522,96 @@ export interface OperationMethods { 'ping'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * findAllOrganizations - Fetch Organizations accessible by Backstage Github Integrations */ 'findAllOrganizations'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * findRepositoriesByOrganization - Fetch Repositories in the specified GitHub organization, provided it is accessible by any of the configured GitHub Integrations. */ 'findRepositoriesByOrganization'( - parameters?: Parameters< - Paths.FindRepositoriesByOrganization.QueryParameters & - Paths.FindRepositoriesByOrganization.PathParameters - > | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * findAllRepositories - Fetch Organization Repositories accessible by Backstage Github Integrations */ 'findAllRepositories'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * findAllImports - Fetch Import Jobs */ 'findAllImports'( - parameters?: Parameters< - Paths.FindAllImports.QueryParameters & - Paths.FindAllImports.HeaderParameters - > | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * createImportJobs - Submit Import Jobs */ 'createImportJobs'( parameters?: Parameters | null, data?: Paths.CreateImportJobs.RequestBody, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * findAllTaskImports - Fetch Import Jobs */ 'findAllTaskImports'( - parameters?: Parameters< - Paths.FindAllTaskImports.QueryParameters & - Paths.FindAllTaskImports.HeaderParameters - > | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * createTaskImportJobs - Execute a scaffolder template for a list of repositories */ 'createTaskImportJobs'( parameters?: Parameters | null, data?: Paths.CreateTaskImportJobs.RequestBody, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * findTaskImportStatusByRepo - Get Import Status by repository */ 'findTaskImportStatusByRepo'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * deleteTaskImportByRepo - Delete stored scaffolder task records for a specific repository */ 'deleteTaskImportByRepo'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * findImportStatusByRepo - Get Import Status by repository */ 'findImportStatusByRepo'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * deleteImportByRepo - Delete Import by repository */ 'deleteImportByRepo'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse } export interface PathsDictionary { @@ -661,9 +622,9 @@ export interface PathsDictionary { 'get'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } ['/organizations']: { /** * findAllOrganizations - Fetch Organizations accessible by Backstage Github Integrations @@ -671,22 +632,19 @@ export interface PathsDictionary { 'get'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } ['/organizations/{organizationName}/repositories']: { /** * findRepositoriesByOrganization - Fetch Repositories in the specified GitHub organization, provided it is accessible by any of the configured GitHub Integrations. */ 'get'( - parameters?: Parameters< - Paths.FindRepositoriesByOrganization.QueryParameters & - Paths.FindRepositoriesByOrganization.PathParameters - > | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } ['/repositories']: { /** * findAllRepositories - Fetch Organization Repositories accessible by Backstage Github Integrations @@ -694,51 +652,45 @@ export interface PathsDictionary { 'get'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } ['/imports']: { /** * findAllImports - Fetch Import Jobs */ 'get'( - parameters?: Parameters< - Paths.FindAllImports.QueryParameters & - Paths.FindAllImports.HeaderParameters - > | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * createImportJobs - Submit Import Jobs */ 'post'( parameters?: Parameters | null, data?: Paths.CreateImportJobs.RequestBody, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } ['/task-imports']: { /** * findAllTaskImports - Fetch Import Jobs */ 'get'( - parameters?: Parameters< - Paths.FindAllTaskImports.QueryParameters & - Paths.FindAllTaskImports.HeaderParameters - > | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * createTaskImportJobs - Execute a scaffolder template for a list of repositories */ 'post'( parameters?: Parameters | null, data?: Paths.CreateTaskImportJobs.RequestBody, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } ['/task-import/by-repo']: { /** * findTaskImportStatusByRepo - Get Import Status by repository @@ -746,17 +698,17 @@ export interface PathsDictionary { 'get'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * deleteTaskImportByRepo - Delete stored scaffolder task records for a specific repository */ 'delete'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } ['/import/by-repo']: { /** * findImportStatusByRepo - Get Import Status by repository @@ -764,20 +716,21 @@ export interface PathsDictionary { 'get'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; + config?: AxiosRequestConfig + ): OperationResponse /** * deleteImportByRepo - Delete Import by repository */ 'delete'( parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig, - ): OperationResponse; - }; + config?: AxiosRequestConfig + ): OperationResponse + } } -export type Client = OpenAPIClient; +export type Client = OpenAPIClient + export type ApprovalTool = Components.Schemas.ApprovalTool; export type Import = Components.Schemas.Import; diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapidocument.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapidocument.ts index 2c34d4573a..caa9076766 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapidocument.ts +++ b/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapidocument.ts @@ -14,6 +14,7 @@ * limitations under the License. */ + // eslint-disable // prettier-ignore const OPENAPI = ` diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/github/GithubAppManager.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/github/GithubAppManager.ts index c395727bd6..aa435a840d 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/src/github/GithubAppManager.ts +++ b/workspaces/bulk-import/plugins/bulk-import-backend/src/github/GithubAppManager.ts @@ -325,9 +325,7 @@ export class GithubAppsCredentialManager { } } -export class CustomSingleInstanceGithubCredentialsProvider - implements ExtendedGithubCredentialsProvider -{ +export class CustomSingleInstanceGithubCredentialsProvider implements ExtendedGithubCredentialsProvider { static readonly create: ( config: GithubIntegrationConfig, ) => ExtendedGithubCredentialsProvider = config => { @@ -456,9 +454,7 @@ export class CustomSingleInstanceGithubCredentialsProvider } } -export class CustomGithubCredentialsProvider - implements ExtendedGithubCredentialsProvider -{ +export class CustomGithubCredentialsProvider implements ExtendedGithubCredentialsProvider { static fromIntegrations(integrations: ScmIntegrationRegistry) { const credentialsProviders: Map = new Map(); diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/github/types.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/github/types.ts index 6d48ce605a..684ff122a7 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/src/github/types.ts +++ b/workspaces/bulk-import/plugins/bulk-import-backend/src/github/types.ts @@ -127,8 +127,7 @@ export function isGithubAppCredential( return 'appId' in credential && credential.type === 'app'; } -export interface ExtendedGithubCredentialsProvider - extends GithubCredentialsProvider { +export interface ExtendedGithubCredentialsProvider extends GithubCredentialsProvider { getAllCredentials: (options: { host: string; }) => Promise; diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/GitlabAppManager.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/GitlabAppManager.ts index ce4326ded2..1201712cd8 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/GitlabAppManager.ts +++ b/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/GitlabAppManager.ts @@ -27,9 +27,7 @@ import { // For reference // https://github.com/backstage/backstage/blob/master/packages/integration/src/gitlab/SingleInstanceGitlabCredentialsProvider.ts -export class CustomSingleInstanceGitlabCredentialsProvider - implements ExtendedGitlabCredentialsProvider -{ +export class CustomSingleInstanceGitlabCredentialsProvider implements ExtendedGitlabCredentialsProvider { static readonly create: ( config: GitLabIntegrationConfig, ) => ExtendedGitlabCredentialsProvider = config => { @@ -54,9 +52,7 @@ export class CustomSingleInstanceGitlabCredentialsProvider } } -export class CustomGitlabCredentialsProvider - implements ExtendedGitlabCredentialsProvider -{ +export class CustomGitlabCredentialsProvider implements ExtendedGitlabCredentialsProvider { static fromIntegrations(integrations: ScmIntegrationRegistry) { const credentialsProviders: Map = new Map(); diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/types.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/types.ts index e1b1e9ffe3..b2aeed9ef7 100644 --- a/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/types.ts +++ b/workspaces/bulk-import/plugins/bulk-import-backend/src/gitlab/types.ts @@ -86,8 +86,7 @@ export type GitlabRepositoryResponse = { export type ExtendedGitlabCredentials = GitlabCredentials; -export interface ExtendedGitlabCredentialsProvider - extends GitlabCredentialsProvider { +export interface ExtendedGitlabCredentialsProvider extends GitlabCredentialsProvider { getAllCredentials: (options: { host: string; }) => Promise; diff --git a/workspaces/bulk-import/plugins/bulk-import-common/package.json b/workspaces/bulk-import/plugins/bulk-import-common/package.json index 3c5108392a..8920b4ce1e 100644 --- a/workspaces/bulk-import/plugins/bulk-import-common/package.json +++ b/workspaces/bulk-import/plugins/bulk-import-common/package.json @@ -38,7 +38,7 @@ "@backstage/cli": "^0.34.5", "@backstage/plugin-permission-common": "^0.9.3", "@spotify/prettier-config": "^15.0.0", - "prettier": "3.6.2" + "prettier": "3.7.4" }, "peerDependencies": { "@backstage/plugin-permission-common": "^0.9.3" diff --git a/workspaces/bulk-import/plugins/bulk-import/package.json b/workspaces/bulk-import/plugins/bulk-import/package.json index 9a8f979e99..417502f669 100644 --- a/workspaces/bulk-import/plugins/bulk-import/package.json +++ b/workspaces/bulk-import/plugins/bulk-import/package.json @@ -86,7 +86,7 @@ "@types/lodash": "^4.14.151", "@types/react": "^18.2.58", "msw": "1.3.5", - "prettier": "3.6.2", + "prettier": "3.7.4", "react": "16.13.1 || ^17.0.0 || ^18.0.0" }, "configSchema": "config.d.ts", diff --git a/workspaces/bulk-import/plugins/bulk-import/src/api/PRBulkImportBackendClientPathProvider.ts b/workspaces/bulk-import/plugins/bulk-import/src/api/PRBulkImportBackendClientPathProvider.ts index 44496f42f1..14133cae91 100644 --- a/workspaces/bulk-import/plugins/bulk-import/src/api/PRBulkImportBackendClientPathProvider.ts +++ b/workspaces/bulk-import/plugins/bulk-import/src/api/PRBulkImportBackendClientPathProvider.ts @@ -17,9 +17,7 @@ import { AddedRepositoryColumnNameEnum, SortingOrderEnum } from '../types'; import { IBulkImportRESTPathProvider } from './BulkImportBackendClient'; -export class PRBulkImportBackendClientPathProvider - implements IBulkImportRESTPathProvider -{ +export class PRBulkImportBackendClientPathProvider implements IBulkImportRESTPathProvider { getCreateImportJobsPath(dryRun?: boolean): string { return dryRun ? `/api/bulk-import/imports?dryRun=true` diff --git a/workspaces/bulk-import/plugins/bulk-import/src/api/ScaffolderBulkImportBackendClientPathProvider.ts b/workspaces/bulk-import/plugins/bulk-import/src/api/ScaffolderBulkImportBackendClientPathProvider.ts index cc1a8092b8..ee3c961060 100644 --- a/workspaces/bulk-import/plugins/bulk-import/src/api/ScaffolderBulkImportBackendClientPathProvider.ts +++ b/workspaces/bulk-import/plugins/bulk-import/src/api/ScaffolderBulkImportBackendClientPathProvider.ts @@ -17,9 +17,7 @@ import { AddedRepositoryColumnNameEnum, SortingOrderEnum } from '../types'; import { IBulkImportRESTPathProvider } from './BulkImportBackendClient'; -export class ScaffolderBulkImportBackendClientPathProvider - implements IBulkImportRESTPathProvider -{ +export class ScaffolderBulkImportBackendClientPathProvider implements IBulkImportRESTPathProvider { getCreateImportJobsPath(dryRun?: boolean): string | undefined { return dryRun === true ? undefined : `/api/bulk-import/task-imports`; } diff --git a/workspaces/bulk-import/yarn.lock b/workspaces/bulk-import/yarn.lock index 4cf84a248a..69e53e49eb 100644 --- a/workspaces/bulk-import/yarn.lock +++ b/workspaces/bulk-import/yarn.lock @@ -10828,7 +10828,7 @@ __metadata: node-fetch: ^2.6.7 openapi-backend: ^5.10.6 openapicmd: 2.7.0 - prettier: 3.6.2 + prettier: 3.7.4 supertest: 6.3.4 peerDependencies: "@janus-idp/backstage-plugin-audit-log-node": ^1.7.0 @@ -10842,7 +10842,7 @@ __metadata: "@backstage/cli": ^0.34.5 "@backstage/plugin-permission-common": ^0.9.3 "@spotify/prettier-config": ^15.0.0 - prettier: 3.6.2 + prettier: 3.7.4 peerDependencies: "@backstage/plugin-permission-common": ^0.9.3 languageName: unknown @@ -10882,7 +10882,7 @@ __metadata: js-yaml: ^4.1.0 lodash: ^4.17.21 msw: 1.3.5 - prettier: 3.6.2 + prettier: 3.7.4 react: 16.13.1 || ^17.0.0 || ^18.0.0 react-use: ^17.2.4 yaml: ^2.0.0 @@ -30095,12 +30095,12 @@ __metadata: languageName: node linkType: hard -"prettier@npm:3.6.2, prettier@npm:^3.4.2": - version: 3.6.2 - resolution: "prettier@npm:3.6.2" +"prettier@npm:3.7.4, prettier@npm:^3.4.2": + version: 3.7.4 + resolution: "prettier@npm:3.7.4" bin: prettier: bin/prettier.cjs - checksum: 0206f5f437892e8858f298af8850bf9d0ef1c22e21107a213ba56bfb9c2387a2020bfda244a20161d8e3dad40c6b04101609a55d370dece53d0a31893b64f861 + checksum: 955e37e87b1151ca3b3282463f5295f4c415821884791df152ff66e6eb1c5257115153cccba61b13962546100dd00ae45670ff27077dcab04c977d84036eaf80 languageName: node linkType: hard diff --git a/yarn.lock b/yarn.lock index 4cd526c829..89ebf4f2b7 100644 --- a/yarn.lock +++ b/yarn.lock @@ -14011,11 +14011,11 @@ __metadata: linkType: hard "prettier@npm:^3.4.2": - version: 3.4.2 - resolution: "prettier@npm:3.4.2" + version: 3.7.4 + resolution: "prettier@npm:3.7.4" bin: prettier: bin/prettier.cjs - checksum: 061c84513db62d3944c8dc8df36584dad82883ce4e49efcdbedd8703dce5b173c33fd9d2a4e1725d642a3b713c932b55418342eaa347479bc4a9cca114a04cd0 + checksum: 955e37e87b1151ca3b3282463f5295f4c415821884791df152ff66e6eb1c5257115153cccba61b13962546100dd00ae45670ff27077dcab04c977d84036eaf80 languageName: node linkType: hard