This is an automated email from the ASF dual-hosted git repository.
rexxiong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/celeborn.git
The following commit(s) were added to refs/heads/main by this push:
new b7e3eaa46 [CELEBORN-1477][FOLLOWUP] Minor fix for v1 RESTful apis
before release
b7e3eaa46 is described below
commit b7e3eaa46d700b4fa790432d022fa9f3ea4a03d7
Author: Wang, Fei <[email protected]>
AuthorDate: Thu Jan 2 23:00:15 2025 +0800
[CELEBORN-1477][FOLLOWUP] Minor fix for v1 RESTful apis before release
### What changes were proposed in this pull request?
Minor fix the v1 RESTful apis before 0.6.0 release.
1. update the API description to use UPPER case worker EventType
2. `subResourceConsumption` => `subResourceConsumptions`.
### Why are the changes needed?
1. With https://github.com/apache/celeborn/pull/2754, the openapi-sdk works
well. but for the RESTful call without SDK, the worker eventType is still case
sensitive, might be caused by the jersey issue mentioned in
https://github.com/eclipse-ee4j/jersey/issues/5288. So, In this PR, I change
the description in the swagger for user guidance.
<img width="1524" alt="image"
src="https://github.com/user-attachments/assets/70e4f239-dc36-47bc-902e-5340986f014a";
/>
2. rename `subResourceConsumption` to `subResourceConsumptions`.
### Does this PR introduce _any_ user-facing change?
No, the api has not been released.
### How was this patch tested?
GA.
Closes #3023 from turboFei/restful_minor_fix.
Authored-by: Wang, Fei <[email protected]>
Signed-off-by: Shuang <[email protected]>
---
.../deploy/master/http/api/v1/WorkerResource.scala | 2 +-
.../apache/celeborn/rest/v1/master/WorkerApi.java | 4 +--
.../rest/v1/model/WorkerResourceConsumption.java | 40 +++++++++++-----------
.../apache/celeborn/rest/v1/worker/WorkerApi.java | 4 +--
.../src/main/openapi3/master_rest_v1.yaml | 4 +--
.../src/main/openapi3/worker_rest_v1.yaml | 4 +--
.../server/common/http/api/v1/ApiUtils.scala | 2 +-
.../deploy/worker/http/api/v1/WorkerResource.scala | 2 +-
8 files changed, 31 insertions(+), 31 deletions(-)
diff --git
a/master/src/main/scala/org/apache/celeborn/service/deploy/master/http/api/v1/WorkerResource.scala
b/master/src/main/scala/org/apache/celeborn/service/deploy/master/http/api/v1/WorkerResource.scala
index fe3cc6eb7..ae8a602f3 100644
---
a/master/src/main/scala/org/apache/celeborn/service/deploy/master/http/api/v1/WorkerResource.scala
+++
b/master/src/main/scala/org/apache/celeborn/service/deploy/master/http/api/v1/WorkerResource.scala
@@ -124,7 +124,7 @@ class WorkerResource extends ApiRequestContext {
mediaType = MediaType.APPLICATION_JSON,
schema = new Schema(implementation = classOf[HandleResponse]))),
description =
- "For Master(Leader) can send worker event to manager workers. Legal
types are 'None', 'Immediately', 'Decommission', 'DecommissionThenIdle',
'Graceful', 'Recommission'.")
+ "For Master(Leader) can send worker event to manager workers. Legal
types are 'NONE', 'IMMEDIATELY', 'DECOMMISSION', 'DECOMMISSIONTHENIDLE',
'GRACEFUL', 'RECOMMISSION'.")
@POST
@Path("/events")
def sendWorkerEvents(request: SendWorkerEventRequest): HandleResponse =
diff --git
a/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/master/WorkerApi.java
b/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/master/WorkerApi.java
index 1a70659ce..f8ca948d0 100644
---
a/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/master/WorkerApi.java
+++
b/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/master/WorkerApi.java
@@ -325,7 +325,7 @@ public class WorkerApi extends BaseApi {
/**
*
- * For Master(Leader) can send worker event to manager workers. Legal types
are 'None', 'Immediately', 'Decommission',
'DecommissionThenIdle', 'Graceful', 'Recommission'.
+ * For Master(Leader) can send worker event to manager workers. Legal types
are 'NONE', 'IMMEDIATELY', 'DECOMMISSION',
'DECOMMISSIONTHENIDLE', 'GRACEFUL', 'RECOMMISSION'.
* @param sendWorkerEventRequest (optional)
* @return HandleResponse
* @throws ApiException if fails to make API call
@@ -337,7 +337,7 @@ public class WorkerApi extends BaseApi {
/**
*
- * For Master(Leader) can send worker event to manager workers. Legal types
are 'None', 'Immediately', 'Decommission',
'DecommissionThenIdle', 'Graceful', 'Recommission'.
+ * For Master(Leader) can send worker event to manager workers. Legal types
are 'NONE', 'IMMEDIATELY', 'DECOMMISSION',
'DECOMMISSIONTHENIDLE', 'GRACEFUL', 'RECOMMISSION'.
* @param sendWorkerEventRequest (optional)
* @param additionalHeaders additionalHeaders for this call
* @return HandleResponse
diff --git
a/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/model/WorkerResourceConsumption.java
b/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/model/WorkerResourceConsumption.java
index 8a1c6c7ff..bcc6b3846 100644
---
a/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/model/WorkerResourceConsumption.java
+++
b/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/model/WorkerResourceConsumption.java
@@ -38,7 +38,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
WorkerResourceConsumption.JSON_PROPERTY_DISK_FILE_COUNT,
WorkerResourceConsumption.JSON_PROPERTY_HDFS_BYTES_WRITTEN,
WorkerResourceConsumption.JSON_PROPERTY_HDFS_FILE_COUNT,
- WorkerResourceConsumption.JSON_PROPERTY_SUB_RESOURCE_CONSUMPTION
+ WorkerResourceConsumption.JSON_PROPERTY_SUB_RESOURCE_CONSUMPTIONS
})
@javax.annotation.Generated(value =
"org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator
version: 7.8.0")
public class WorkerResourceConsumption {
@@ -54,8 +54,8 @@ public class WorkerResourceConsumption {
public static final String JSON_PROPERTY_HDFS_FILE_COUNT = "hdfsFileCount";
private Long hdfsFileCount;
- public static final String JSON_PROPERTY_SUB_RESOURCE_CONSUMPTION =
"subResourceConsumption";
- private Map<String, WorkerResourceConsumption> subResourceConsumption = new
HashMap<>();
+ public static final String JSON_PROPERTY_SUB_RESOURCE_CONSUMPTIONS =
"subResourceConsumptions";
+ private Map<String, WorkerResourceConsumption> subResourceConsumptions = new
HashMap<>();
public WorkerResourceConsumption() {
}
@@ -160,37 +160,37 @@ public class WorkerResourceConsumption {
this.hdfsFileCount = hdfsFileCount;
}
- public WorkerResourceConsumption subResourceConsumption(Map<String,
WorkerResourceConsumption> subResourceConsumption) {
+ public WorkerResourceConsumption subResourceConsumptions(Map<String,
WorkerResourceConsumption> subResourceConsumptions) {
- this.subResourceConsumption = subResourceConsumption;
+ this.subResourceConsumptions = subResourceConsumptions;
return this;
}
- public WorkerResourceConsumption putSubResourceConsumptionItem(String key,
WorkerResourceConsumption subResourceConsumptionItem) {
- if (this.subResourceConsumption == null) {
- this.subResourceConsumption = new HashMap<>();
+ public WorkerResourceConsumption putSubResourceConsumptionsItem(String key,
WorkerResourceConsumption subResourceConsumptionsItem) {
+ if (this.subResourceConsumptions == null) {
+ this.subResourceConsumptions = new HashMap<>();
}
- this.subResourceConsumption.put(key, subResourceConsumptionItem);
+ this.subResourceConsumptions.put(key, subResourceConsumptionsItem);
return this;
}
/**
- * Get subResourceConsumption
- * @return subResourceConsumption
+ * Get subResourceConsumptions
+ * @return subResourceConsumptions
*/
@javax.annotation.Nullable
- @JsonProperty(JSON_PROPERTY_SUB_RESOURCE_CONSUMPTION)
+ @JsonProperty(JSON_PROPERTY_SUB_RESOURCE_CONSUMPTIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
- public Map<String, WorkerResourceConsumption> getSubResourceConsumption() {
- return subResourceConsumption;
+ public Map<String, WorkerResourceConsumption> getSubResourceConsumptions() {
+ return subResourceConsumptions;
}
- @JsonProperty(JSON_PROPERTY_SUB_RESOURCE_CONSUMPTION)
+ @JsonProperty(JSON_PROPERTY_SUB_RESOURCE_CONSUMPTIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
- public void setSubResourceConsumption(Map<String, WorkerResourceConsumption>
subResourceConsumption) {
- this.subResourceConsumption = subResourceConsumption;
+ public void setSubResourceConsumptions(Map<String,
WorkerResourceConsumption> subResourceConsumptions) {
+ this.subResourceConsumptions = subResourceConsumptions;
}
@Override
@@ -206,12 +206,12 @@ public class WorkerResourceConsumption {
Objects.equals(this.diskFileCount,
workerResourceConsumption.diskFileCount) &&
Objects.equals(this.hdfsBytesWritten,
workerResourceConsumption.hdfsBytesWritten) &&
Objects.equals(this.hdfsFileCount,
workerResourceConsumption.hdfsFileCount) &&
- Objects.equals(this.subResourceConsumption,
workerResourceConsumption.subResourceConsumption);
+ Objects.equals(this.subResourceConsumptions,
workerResourceConsumption.subResourceConsumptions);
}
@Override
public int hashCode() {
- return Objects.hash(diskBytesWritten, diskFileCount, hdfsBytesWritten,
hdfsFileCount, subResourceConsumption);
+ return Objects.hash(diskBytesWritten, diskFileCount, hdfsBytesWritten,
hdfsFileCount, subResourceConsumptions);
}
@Override
@@ -222,7 +222,7 @@ public class WorkerResourceConsumption {
sb.append(" diskFileCount:
").append(toIndentedString(diskFileCount)).append("\n");
sb.append(" hdfsBytesWritten:
").append(toIndentedString(hdfsBytesWritten)).append("\n");
sb.append(" hdfsFileCount:
").append(toIndentedString(hdfsFileCount)).append("\n");
- sb.append(" subResourceConsumption:
").append(toIndentedString(subResourceConsumption)).append("\n");
+ sb.append(" subResourceConsumptions:
").append(toIndentedString(subResourceConsumptions)).append("\n");
sb.append("}");
return sb.toString();
}
diff --git
a/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/worker/WorkerApi.java
b/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/worker/WorkerApi.java
index 532575a66..0cce44ea0 100644
---
a/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/worker/WorkerApi.java
+++
b/openapi/openapi-client/src/main/java/org/apache/celeborn/rest/v1/worker/WorkerApi.java
@@ -185,7 +185,7 @@ public class WorkerApi extends BaseApi {
/**
*
- * Trigger this worker to exit. Legal exit types are 'Decommission',
'Graceful' and 'Immediately'.
+ * Trigger this worker to exit. Legal exit types are 'DECOMMISSION',
'GRACEFUL' and 'IMMEDIATELY'.
* @param workerExitRequest (optional)
* @return HandleResponse
* @throws ApiException if fails to make API call
@@ -197,7 +197,7 @@ public class WorkerApi extends BaseApi {
/**
*
- * Trigger this worker to exit. Legal exit types are 'Decommission',
'Graceful' and 'Immediately'.
+ * Trigger this worker to exit. Legal exit types are 'DECOMMISSION',
'GRACEFUL' and 'IMMEDIATELY'.
* @param workerExitRequest (optional)
* @param additionalHeaders additionalHeaders for this call
* @return HandleResponse
diff --git a/openapi/openapi-client/src/main/openapi3/master_rest_v1.yaml
b/openapi/openapi-client/src/main/openapi3/master_rest_v1.yaml
index c135eb7d7..f2676d269 100644
--- a/openapi/openapi-client/src/main/openapi3/master_rest_v1.yaml
+++ b/openapi/openapi-client/src/main/openapi3/master_rest_v1.yaml
@@ -212,7 +212,7 @@ paths:
operationId: sendWorkerEvent
description: |
For Master(Leader) can send worker event to manager workers.
- Legal types are 'None', 'Immediately', 'Decommission',
'DecommissionThenIdle', 'Graceful', 'Recommission'.
+ Legal types are 'NONE', 'IMMEDIATELY', 'DECOMMISSION',
'DECOMMISSIONTHENIDLE', 'GRACEFUL', 'RECOMMISSION'.
requestBody:
content:
application/json:
@@ -863,7 +863,7 @@ components:
hdfsFileCount:
type: integer
format: int64
- subResourceConsumption:
+ subResourceConsumptions:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkerResourceConsumption'
diff --git a/openapi/openapi-client/src/main/openapi3/worker_rest_v1.yaml
b/openapi/openapi-client/src/main/openapi3/worker_rest_v1.yaml
index 830d77211..e0f70a1cc 100644
--- a/openapi/openapi-client/src/main/openapi3/worker_rest_v1.yaml
+++ b/openapi/openapi-client/src/main/openapi3/worker_rest_v1.yaml
@@ -172,7 +172,7 @@ paths:
operationId: workerExit
description: |
Trigger this worker to exit.
- Legal exit types are 'Decommission', 'Graceful' and 'Immediately'.
+ Legal exit types are 'DECOMMISSION', 'GRACEFUL' and 'IMMEDIATELY'.
requestBody:
content:
application/json:
@@ -574,7 +574,7 @@ components:
hdfsFileCount:
type: integer
format: int64
- subResourceConsumption:
+ subResourceConsumptions:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkerResourceConsumption'
diff --git
a/service/src/main/scala/org/apache/celeborn/server/common/http/api/v1/ApiUtils.scala
b/service/src/main/scala/org/apache/celeborn/server/common/http/api/v1/ApiUtils.scala
index 799fec86e..c302a4243 100644
---
a/service/src/main/scala/org/apache/celeborn/server/common/http/api/v1/ApiUtils.scala
+++
b/service/src/main/scala/org/apache/celeborn/server/common/http/api/v1/ApiUtils.scala
@@ -84,7 +84,7 @@ object ApiUtils {
.diskFileCount(resourceConsumption.diskFileCount)
.hdfsBytesWritten(resourceConsumption.hdfsBytesWritten)
.hdfsFileCount(resourceConsumption.hdfsFileCount)
- .subResourceConsumption(subConsumptions)
+ .subResourceConsumptions(subConsumptions)
workerResourceConsumptions.put(userIdentifier.toString,
workerConsumption)
}
diff --git
a/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/http/api/v1/WorkerResource.scala
b/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/http/api/v1/WorkerResource.scala
index 3748df63e..24e2b39f8 100644
---
a/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/http/api/v1/WorkerResource.scala
+++
b/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/http/api/v1/WorkerResource.scala
@@ -77,7 +77,7 @@ class WorkerResource extends ApiRequestContext {
schema = new Schema(
implementation = classOf[HandleResponse]))),
description =
- "Trigger this worker to exit. Legal exit types are 'Decommission',
'Graceful' and 'Immediately'.")
+ "Trigger this worker to exit. Legal exit types are 'DECOMMISSION',
'GRACEFUL' and 'IMMEDIATELY'.")
@POST
@Path("exit")
def exit(request: WorkerExitRequest): HandleResponse = {
