Skip to content

Commit 6c1d182

Browse files
fix: fixed the wrong spelling issue and operationId missing issue (#16)
1 parent 03caac4 commit 6c1d182

File tree

23 files changed

+433
-1277
lines changed

23 files changed

+433
-1277
lines changed

apollo-openapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2395,6 +2395,7 @@ paths:
23952395
/openapi/v1/envs/{env}/releases/{releaseId}/instances:
23962396
get:
23972397
summary: 根据发布版本查询实例(支持分页) (new added)
2398+
operationId: getByRelease
23982399
deprecated: false
23992400
description: GET /openapi/v1/envs/{env}/releases/{releaseId}/instances
24002401
tags:
@@ -2461,9 +2462,10 @@ paths:
24612462
dataChangeLastModifiedTime: ''
24622463
dataChangeCreatedTime: ''
24632464
headers: {}
2464-
/openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_int: # avoidng confliction with other server endpoint
2465+
/openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_in: # avoidng confliction with other server endpoint
24652466
get:
24662467
summary: 查询不在指定发布版本中的实例 (new added)
2468+
operationId: getByReleasesNotIn
24672469
deprecated: false
24682470
description: >-
24692471
GET

java-client/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ Class | Method | HTTP request | Description
149149
*ClusterManagementApi* | [**createCluster**](docs/ClusterManagementApi.md#createCluster) | **POST** /openapi/v1/envs/{env}/apps/{appId}/clusters | 创建集群 (original openapi)
150150
*ClusterManagementApi* | [**deleteCluster**](docs/ClusterManagementApi.md#deleteCluster) | **DELETE** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName} | 删除集群 (new added)
151151
*ClusterManagementApi* | [**getCluster**](docs/ClusterManagementApi.md#getCluster) | **GET** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName} | 获取指定集群信息 (original openapi)
152+
*InstanceManagementApi* | [**getByRelease**](docs/InstanceManagementApi.md#getByRelease) | **GET** /openapi/v1/envs/{env}/releases/{releaseId}/instances | 根据发布版本查询实例(支持分页) (new added)
153+
*InstanceManagementApi* | [**getByReleasesNotIn**](docs/InstanceManagementApi.md#getByReleasesNotIn) | **GET** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_in | 查询不在指定发布版本中的实例 (new added)
152154
*InstanceManagementApi* | [**getInstanceCountByNamespace**](docs/InstanceManagementApi.md#getInstanceCountByNamespace) | **GET** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances | 获取命名空间下的实例数量 (original openapi)
153-
*InstanceManagementApi* | [**openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet**](docs/InstanceManagementApi.md#openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet) | **GET** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_int | 查询不在指定发布版本中的实例 (new added)
154-
*InstanceManagementApi* | [**openapiV1EnvsEnvReleasesReleaseIdInstancesGet**](docs/InstanceManagementApi.md#openapiV1EnvsEnvReleasesReleaseIdInstancesGet) | **GET** /openapi/v1/envs/{env}/releases/{releaseId}/instances | 根据发布版本查询实例(支持分页) (new added)
155155
*ItemManagementApi* | [**batchUpdateItemsByText**](docs/ItemManagementApi.md#batchUpdateItemsByText) | **PUT** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items/batchUpdate | 通过文本批量修改配置项 (new added)
156156
*ItemManagementApi* | [**compareItems**](docs/ItemManagementApi.md#compareItems) | **POST** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items/compare | 对比命名空间配置差异 (new added)
157157
*ItemManagementApi* | [**createItem**](docs/ItemManagementApi.md#createItem) | **POST** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items | 创建新的配置项 (original openapi)

java-client/api/openapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2680,6 +2680,7 @@ paths:
26802680
get:
26812681
deprecated: false
26822682
description: "GET /openapi/v1/envs/{env}/releases/{releaseId}/instances"
2683+
operationId: getByRelease
26832684
parameters:
26842685
- description: ""
26852686
explode: false
@@ -2754,10 +2755,11 @@ paths:
27542755
tags:
27552756
- Instance Management
27562757
x-accepts: application/json
2757-
/openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_int:
2758+
/openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_in:
27582759
get:
27592760
deprecated: false
27602761
description: "GET /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances?excludeReleases=1,2,3"
2762+
operationId: getByReleasesNotIn
27612763
parameters:
27622764
- description: 环境标识
27632765
explode: false

java-client/docs/InstanceManagementApi.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ All URIs are relative to *http://localhost*
44

55
| Method | HTTP request | Description |
66
|------------- | ------------- | -------------|
7+
| [**getByRelease**](InstanceManagementApi.md#getByRelease) | **GET** /openapi/v1/envs/{env}/releases/{releaseId}/instances | 根据发布版本查询实例(支持分页) (new added) |
8+
| [**getByReleasesNotIn**](InstanceManagementApi.md#getByReleasesNotIn) | **GET** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_in | 查询不在指定发布版本中的实例 (new added) |
79
| [**getInstanceCountByNamespace**](InstanceManagementApi.md#getInstanceCountByNamespace) | **GET** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances | 获取命名空间下的实例数量 (original openapi) |
8-
| [**openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet**](InstanceManagementApi.md#openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet) | **GET** /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances_not_int | 查询不在指定发布版本中的实例 (new added) |
9-
| [**openapiV1EnvsEnvReleasesReleaseIdInstancesGet**](InstanceManagementApi.md#openapiV1EnvsEnvReleasesReleaseIdInstancesGet) | **GET** /openapi/v1/envs/{env}/releases/{releaseId}/instances | 根据发布版本查询实例(支持分页) (new added) |
1010

1111

12-
<a id="getInstanceCountByNamespace"></a>
13-
# **getInstanceCountByNamespace**
14-
> Integer getInstanceCountByNamespace(env, appId, clusterName, namespaceName)
12+
<a id="getByRelease"></a>
13+
# **getByRelease**
14+
> OpenPageDTOOpenInstanceDTO getByRelease(env, releaseId, page, size)
1515
16-
获取命名空间下的实例数量 (original openapi)
16+
根据发布版本查询实例(支持分页) (new added)
1717

18-
GET /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances
18+
GET /openapi/v1/envs/{env}/releases/{releaseId}/instances
1919

2020
### Example
2121
```java
@@ -40,14 +40,14 @@ public class Example {
4040

4141
InstanceManagementApi apiInstance = new InstanceManagementApi(defaultClient);
4242
String env = "env_example"; // String |
43-
String appId = "appId_example"; // String | 应用ID
44-
String clusterName = "clusterName_example"; // String | 集群名称
45-
String namespaceName = "namespaceName_example"; // String | 命名空间名称
43+
Integer releaseId = 56; // Integer |
44+
Integer page = 0; // Integer |
45+
Integer size = 20; // Integer |
4646
try {
47-
Integer result = apiInstance.getInstanceCountByNamespace(env, appId, clusterName, namespaceName);
47+
OpenPageDTOOpenInstanceDTO result = apiInstance.getByRelease(env, releaseId, page, size);
4848
System.out.println(result);
4949
} catch (ApiException e) {
50-
System.err.println("Exception when calling InstanceManagementApi#getInstanceCountByNamespace");
50+
System.err.println("Exception when calling InstanceManagementApi#getByRelease");
5151
System.err.println("Status code: " + e.getCode());
5252
System.err.println("Reason: " + e.getResponseBody());
5353
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -62,13 +62,13 @@ public class Example {
6262
| Name | Type | Description | Notes |
6363
|------------- | ------------- | ------------- | -------------|
6464
| **env** | **String**| | |
65-
| **appId** | **String**| 应用ID | |
66-
| **clusterName** | **String**| 集群名称 | |
67-
| **namespaceName** | **String**| 命名空间名称 | |
65+
| **releaseId** | **Integer**| | |
66+
| **page** | **Integer**| | |
67+
| **size** | **Integer**| | |
6868

6969
### Return type
7070

71-
**Integer**
71+
[**OpenPageDTOOpenInstanceDTO**](OpenPageDTOOpenInstanceDTO.md)
7272

7373
### Authorization
7474

@@ -82,11 +82,11 @@ public class Example {
8282
### HTTP response details
8383
| Status code | Description | Response headers |
8484
|-------------|-------------|------------------|
85-
| **200** | 成功返回实例数量 | - |
85+
| **200** | | - |
8686

87-
<a id="openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet"></a>
88-
# **openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet**
89-
> List&lt;OpenInstanceDTO&gt; openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet(env, appId, clusterName, namespaceName, excludeReleases)
87+
<a id="getByReleasesNotIn"></a>
88+
# **getByReleasesNotIn**
89+
> List&lt;OpenInstanceDTO&gt; getByReleasesNotIn(env, appId, clusterName, namespaceName, excludeReleases)
9090
9191
查询不在指定发布版本中的实例 (new added)
9292

@@ -120,10 +120,10 @@ public class Example {
120120
String namespaceName = "namespaceName_example"; // String | 命名空间名称
121121
String excludeReleases = "excludeReleases_example"; // String | 排除的发布ID列表,用逗号分隔
122122
try {
123-
List<OpenInstanceDTO> result = apiInstance.openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet(env, appId, clusterName, namespaceName, excludeReleases);
123+
List<OpenInstanceDTO> result = apiInstance.getByReleasesNotIn(env, appId, clusterName, namespaceName, excludeReleases);
124124
System.out.println(result);
125125
} catch (ApiException e) {
126-
System.err.println("Exception when calling InstanceManagementApi#openapiV1EnvsEnvAppsAppIdClustersClusterNameNamespacesNamespaceNameInstancesNotIntGet");
126+
System.err.println("Exception when calling InstanceManagementApi#getByReleasesNotIn");
127127
System.err.println("Status code: " + e.getCode());
128128
System.err.println("Reason: " + e.getResponseBody());
129129
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -161,13 +161,13 @@ public class Example {
161161
|-------------|-------------|------------------|
162162
| **200** | | - |
163163

164-
<a id="openapiV1EnvsEnvReleasesReleaseIdInstancesGet"></a>
165-
# **openapiV1EnvsEnvReleasesReleaseIdInstancesGet**
166-
> OpenPageDTOOpenInstanceDTO openapiV1EnvsEnvReleasesReleaseIdInstancesGet(env, releaseId, page, size)
164+
<a id="getInstanceCountByNamespace"></a>
165+
# **getInstanceCountByNamespace**
166+
> Integer getInstanceCountByNamespace(env, appId, clusterName, namespaceName)
167167
168-
根据发布版本查询实例(支持分页) (new added)
168+
获取命名空间下的实例数量 (original openapi)
169169

170-
GET /openapi/v1/envs/{env}/releases/{releaseId}/instances
170+
GET /openapi/v1/envs/{env}/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/instances
171171

172172
### Example
173173
```java
@@ -192,14 +192,14 @@ public class Example {
192192

193193
InstanceManagementApi apiInstance = new InstanceManagementApi(defaultClient);
194194
String env = "env_example"; // String |
195-
Integer releaseId = 56; // Integer |
196-
Integer page = 0; // Integer |
197-
Integer size = 20; // Integer |
195+
String appId = "appId_example"; // String | 应用ID
196+
String clusterName = "clusterName_example"; // String | 集群名称
197+
String namespaceName = "namespaceName_example"; // String | 命名空间名称
198198
try {
199-
OpenPageDTOOpenInstanceDTO result = apiInstance.openapiV1EnvsEnvReleasesReleaseIdInstancesGet(env, releaseId, page, size);
199+
Integer result = apiInstance.getInstanceCountByNamespace(env, appId, clusterName, namespaceName);
200200
System.out.println(result);
201201
} catch (ApiException e) {
202-
System.err.println("Exception when calling InstanceManagementApi#openapiV1EnvsEnvReleasesReleaseIdInstancesGet");
202+
System.err.println("Exception when calling InstanceManagementApi#getInstanceCountByNamespace");
203203
System.err.println("Status code: " + e.getCode());
204204
System.err.println("Reason: " + e.getResponseBody());
205205
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -214,13 +214,13 @@ public class Example {
214214
| Name | Type | Description | Notes |
215215
|------------- | ------------- | ------------- | -------------|
216216
| **env** | **String**| | |
217-
| **releaseId** | **Integer**| | |
218-
| **page** | **Integer**| | |
219-
| **size** | **Integer**| | |
217+
| **appId** | **String**| 应用ID | |
218+
| **clusterName** | **String**| 集群名称 | |
219+
| **namespaceName** | **String**| 命名空间名称 | |
220220

221221
### Return type
222222

223-
[**OpenPageDTOOpenInstanceDTO**](OpenPageDTOOpenInstanceDTO.md)
223+
**Integer**
224224

225225
### Authorization
226226

@@ -234,4 +234,4 @@ public class Example {
234234
### HTTP response details
235235
| Status code | Description | Response headers |
236236
|-------------|-------------|------------------|
237-
| **200** | | - |
237+
| **200** | 成功返回实例数量 | - |

0 commit comments

Comments
 (0)