Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions workspaces/bulk-import/.changeset/curly-peaches-build.md
Original file line number Diff line number Diff line change
@@ -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`.
5 changes: 5 additions & 0 deletions workspaces/bulk-import/.prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -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

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -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 |

<a name="ping"></a>

<a name="ping"></a>
# **ping**

> ping_200_response ping()

Check the health of the Bulk Import backend router

### Parameters

This endpoint does not need any parameter.

### Return type
Expand All @@ -30,3 +28,4 @@ No authorization required

- **Content-Type**: Not defined
- **Accept**: application/json

Original file line number Diff line number Diff line change
@@ -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. |

<a name="findAllOrganizations"></a>

<a name="findAllOrganizations"></a>
# **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

Expand All @@ -38,23 +37,21 @@ Fetch Organizations accessible by Backstage Github Integrations
- **Accept**: application/json

<a name="findRepositoriesByOrganization"></a>

# **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

Expand All @@ -68,3 +65,4 @@ Fetch Repositories in the specified GitHub organization, provided it is accessib

- **Content-Type**: Not defined
- **Accept**: application/json

Original file line number Diff line number Diff line change
@@ -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 |

<a name="findAllRepositories"></a>

<a name="findAllRepositories"></a>
# **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

Expand All @@ -36,3 +35,4 @@ Fetch Organization Repositories accessible by Backstage Github Integrations

- **Content-Type**: Not defined
- **Accept**: application/json

Original file line number Diff line number Diff line change
@@ -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)

Original file line number Diff line number Diff line change
@@ -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)

Original file line number Diff line number Diff line change
@@ -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)

Loading