celeborn/openapi/openapi-client
2025-05-21 17:20:12 -07:00
..
src/main Bump 0.7.0-SNAPSHOT 2025-05-21 17:20:12 -07:00
pom.xml [CELEBORN-1477][FOLLOWUP] Remove scala binary version from openapi-client artifactId 2024-11-01 15:08:00 +08:00
README.md [CELEBORN-1601][FOLLOWUP] Refine the RESTful apis for revise lost shuffles 2024-11-12 10:11:25 +08:00

Celeborn OpenAPI Client

Note: It is recommended to use under_score style naming for new RESTful APIs to maintain consistency.

To update the OpenAPI specification

  • just update the specification under openapi/openapi-client/src/main/openapi3/ and keep the schema definitions consistent between master and worker.
  • Install JDK 11 or above by whatever mechanism is appropriate for your system, and set that version to be the default Java version (e.g., by setting env variable JAVA_HOME)
  • run the following:
    build/mvn -pl openapi/openapi-client clean package -Pgenerate
    
    or
    build/sbt "clean;celeborn-openapi-client/generate"
    
    This will regenerate the OpenAPI data models + APIs in the celeborn-openapi-client SDK.