apache/celeborn
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
c9ca90c5ee
celeborn/openapi/openapi-client
History
Wang, Fei f1b71e3eb7 [CELEBORN-1436][FOLLOWUP] Add swagger editor links for RESTful spec 
### What changes were proposed in this pull request?

Add swagger editor links for RESTful spec.

Fix warn in the spec:
Master spec:
![image](https://github.com/user-attachments/assets/ff71aedf-c68d-472a-b0f8-e526d87d45ed)

Worker spec:
![image](https://github.com/user-attachments/assets/6820a25e-679f-4790-a3c2-d2757b34b0e4)

### Why are the changes needed?

To view the spec online.

### Does this PR introduce _any_ user-facing change?
No.

### How was this patch tested?
<img width="1103" alt="image" src="https://github.com/user-attachments/assets/0118e47d-da2d-43c8-a41d-085cde2ed06f" />

No warn now, see:
https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/turbofei/incubator-celeborn/openapi/openapi/openapi-client/src/main/openapi3/master_rest_v1.yaml

https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/turbofei/incubator-celeborn/openapi/openapi/openapi-client/src/main/openapi3/worker_rest_v1.yaml

Closes #3200 from turboFei/openapi.

Authored-by: Wang, Fei <fwang12@ebay.com>
Signed-off-by: Shuang <lvshuang.xjs@alibaba-inc.com>
2025-04-21 15:28:52 +08:00
..
src/main [CELEBORN-1436][FOLLOWUP] Add swagger editor links for RESTful spec 2025-04-21 15:28:52 +08: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

README.md

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.