Skip to content

Commit dd158b9

Browse files
kim-tsaokim-tsao
committed
address review comments
Signed-off-by: Kim Tsao <ktsao@redhat.com>
1 parent 9e229b1 commit dd158b9

30 files changed

+850
-908
lines changed

‎workspaces/bulk-import/.prettierignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,8 @@ dist-types
33
coverage
44
.vscode
55
.eslintrc.js
6+
7+
# Generated
8+
plugins/bulk-import-backend/api-docs
9+
plugins/bulk-import-backend/src/generated/openapi.d.ts
10+
plugins/bulk-import-backend/src/generated/openapidocument.ts

‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ImportApi.md‎

Lines changed: 61 additions & 75 deletions
Large diffs are not rendered by default.

‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ManagementApi.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
# ManagementApi
22

3-
All URIs are relative to _http://localhost:7007/api/bulk-import_
3+
All URIs are relative to *http://localhost:7007/api/bulk-import*
44

5-
| Method | HTTP request | Description |
6-
| --------------------------------- | ------------- | -------------------------------------------------- |
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
77
| [**ping**](ManagementApi.md#ping) | **GET** /ping | Check the health of the Bulk Import backend router |
88

9-
<a name="ping"></a>
109

10+
<a name="ping"></a>
1111
# **ping**
12-
1312
> ping_200_response ping()
1413
1514
Check the health of the Bulk Import backend router
1615

1716
### Parameters
18-
1917
This endpoint does not need any parameter.
2018

2119
### Return type
@@ -30,3 +28,4 @@ No authorization required
3028

3129
- **Content-Type**: Not defined
3230
- **Accept**: application/json
31+

‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/OrganizationApi.md‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
# OrganizationApi
22

3-
All URIs are relative to _http://localhost:7007/api/bulk-import_
3+
All URIs are relative to *http://localhost:7007/api/bulk-import*
44

5-
| Method | HTTP request | Description |
6-
| --------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
7-
| [**findAllOrganizations**](OrganizationApi.md#findAllOrganizations) | **GET** /organizations | Fetch Organizations accessible by Backstage Github Integrations |
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
7+
| [**findAllOrganizations**](OrganizationApi.md#findAllOrganizations) | **GET** /organizations | Fetch Organizations accessible by Backstage Github Integrations |
88
| [**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. |
99

10-
<a name="findAllOrganizations"></a>
1110

11+
<a name="findAllOrganizations"></a>
1212
# **findAllOrganizations**
13-
1413
> OrganizationList findAllOrganizations(pagePerIntegration, sizePerIntegration, search, approvalTool)
1514
1615
Fetch Organizations accessible by Backstage Github Integrations
1716

1817
### Parameters
1918

20-
| Name | Type | Description | Notes |
21-
| ---------------------- | ----------- | ------------------------------------------------------ | ---------------------------- |
22-
| **pagePerIntegration** | **Integer** | the page number for each Integration | [optional] [default to 1] |
23-
| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page | [optional] [default to 20] |
24-
| **search** | **String** | returns only the items that match the search string | [optional] [default to null] |
25-
| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] |
19+
|Name | Type | Description | Notes |
20+
|------------- | ------------- | ------------- | -------------|
21+
| **pagePerIntegration** | **Integer**| the page number for each Integration | [optional] [default to 1] |
22+
| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] |
23+
| **search** | **String**| returns only the items that match the search string | [optional] [default to null] |
24+
| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] |
2625

2726
### Return type
2827

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

4039
<a name="findRepositoriesByOrganization"></a>
41-
4240
# **findRepositoriesByOrganization**
43-
4441
> RepositoryList findRepositoriesByOrganization(organizationName, checkImportStatus, pagePerIntegration, sizePerIntegration, search, approvalTool)
4542
4643
Fetch Repositories in the specified GitHub organization, provided it is accessible by any of the configured GitHub Integrations.
4744

4845
### Parameters
4946

50-
| Name | Type | Description | Notes |
51-
| ---------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
52-
| **organizationName** | **String** | Organization name | [default to null] |
53-
| **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] |
54-
| **pagePerIntegration** | **Integer** | the page number for each Integration | [optional] [default to 1] |
55-
| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page | [optional] [default to 20] |
56-
| **search** | **String** | returns only the items that match the search string | [optional] [default to null] |
57-
| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] |
47+
|Name | Type | Description | Notes |
48+
|------------- | ------------- | ------------- | -------------|
49+
| **organizationName** | **String**| Organization name | [default to null] |
50+
| **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] |
51+
| **pagePerIntegration** | **Integer**| the page number for each Integration | [optional] [default to 1] |
52+
| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] |
53+
| **search** | **String**| returns only the items that match the search string | [optional] [default to null] |
54+
| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] |
5855

5956
### Return type
6057

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

6966
- **Content-Type**: Not defined
7067
- **Accept**: application/json
68+

‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/RepositoryApi.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
# RepositoryApi
22

3-
All URIs are relative to _http://localhost:7007/api/bulk-import_
3+
All URIs are relative to *http://localhost:7007/api/bulk-import*
44

5-
| Method | HTTP request | Description |
6-
| --------------------------------------------------------------- | --------------------- | --------------------------------------------------------------------------- |
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
77
| [**findAllRepositories**](RepositoryApi.md#findAllRepositories) | **GET** /repositories | Fetch Organization Repositories accessible by Backstage Github Integrations |
88

9-
<a name="findAllRepositories"></a>
109

10+
<a name="findAllRepositories"></a>
1111
# **findAllRepositories**
12-
1312
> RepositoryList findAllRepositories(checkImportStatus, pagePerIntegration, sizePerIntegration, search, approvalTool)
1413
1514
Fetch Organization Repositories accessible by Backstage Github Integrations
1615

1716
### Parameters
1817

19-
| Name | Type | Description | Notes |
20-
| ---------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
21-
| **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] |
22-
| **pagePerIntegration** | **Integer** | the page number for each Integration | [optional] [default to 1] |
23-
| **sizePerIntegration** | **Integer** | the number of items per Integration to return per page | [optional] [default to 20] |
24-
| **search** | **String** | returns only the items that match the search string | [optional] [default to null] |
25-
| **approvalTool** | **String** | the approvalTool to use | [optional] [default to GIT] |
18+
|Name | Type | Description | Notes |
19+
|------------- | ------------- | ------------- | -------------|
20+
| **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] |
21+
| **pagePerIntegration** | **Integer**| the page number for each Integration | [optional] [default to 1] |
22+
| **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] |
23+
| **search** | **String**| returns only the items that match the search string | [optional] [default to null] |
24+
| **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] |
2625

2726
### Return type
2827

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

3736
- **Content-Type**: Not defined
3837
- **Accept**: application/json
38+

‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ApprovalTool.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ApprovalTool
2-
32
## Properties
43

54
| Name | Type | Description | Notes |
6-
| ---- | ---- | ----------- | ----- |
5+
|------------ | ------------- | ------------- | -------------|
76

87
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+

‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/Import.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Import
2-
32
## Properties
43

5-
| Name | Type | Description | Notes |
6-
| --------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------- |
7-
| **id** | **String** | | [optional] [default to null] |
8-
| **status** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] |
9-
| **task** | [**Import_task**](Import_task.md) | | [optional] [default to null] |
10-
| **tasks** | [**List**](Import_task.md) | | [optional] [default to null] |
11-
| **catalogEntityName** | **String** | Specified entity name in the catalog. Filled only in response for dry-run import requests. | [optional] [default to null] |
12-
| **lastUpdate** | **Date** | | [optional] [default to null] |
13-
| **errors** | **List** | | [optional] [default to null] |
14-
| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] |
15-
| **repository** | [**Repository**](Repository.md) | | [optional] [default to null] |
16-
| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] |
17-
| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] |
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **id** | **String** | | [optional] [default to null] |
7+
| **status** | [**Repository_importStatus**](Repository_importStatus.md) | | [optional] [default to null] |
8+
| **task** | [**Import_task**](Import_task.md) | | [optional] [default to null] |
9+
| **tasks** | [**List**](Import_task.md) | | [optional] [default to null] |
10+
| **catalogEntityName** | **String** | Specified entity name in the catalog. Filled only in response for dry-run import requests. | [optional] [default to null] |
11+
| **lastUpdate** | **Date** | | [optional] [default to null] |
12+
| **errors** | **List** | | [optional] [default to null] |
13+
| **approvalTool** | [**ApprovalTool**](ApprovalTool.md) | | [optional] [default to null] |
14+
| **repository** | [**Repository**](Repository.md) | | [optional] [default to null] |
15+
| **gitlab** | [**Import_gitlab**](Import_gitlab.md) | | [optional] [default to null] |
16+
| **github** | [**Import_github**](Import_github.md) | | [optional] [default to null] |
1817

1918
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19+

‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Models/ImportJobListV2.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# ImportJobListV2
2-
32
## Properties
43

5-
| Name | Type | Description | Notes |
6-
| -------------- | --------------------------- | ----------- | ---------------------------- |
7-
| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] |
8-
| **errors** | **List** | | [optional] [default to null] |
9-
| **totalCount** | **Integer** | | [optional] [default to null] |
10-
| **page** | **Integer** | | [optional] [default to null] |
11-
| **size** | **Integer** | | [optional] [default to null] |
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **imports** | [**List**](SourceImport.md) | | [optional] [default to null] |
7+
| **errors** | **List** | | [optional] [default to null] |
8+
| **totalCount** | **Integer** | | [optional] [default to null] |
9+
| **page** | **Integer** | | [optional] [default to null] |
10+
| **size** | **Integer** | | [optional] [default to null] |
1211

1312
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+

0 commit comments

Comments
 (0)