[CELEBORN-1317][FOLLOWUP] Improve parameters, description and document of REST API#2495
Closed
SteNicholas wants to merge 2 commits intoapache:mainfrom
Closed
[CELEBORN-1317][FOLLOWUP] Improve parameters, description and document of REST API#2495SteNicholas wants to merge 2 commits intoapache:mainfrom
SteNicholas wants to merge 2 commits intoapache:mainfrom
Conversation
Member
Author
turboFei
reviewed
May 8, 2024
...er/src/main/scala/org/apache/celeborn/service/deploy/master/http/api/ApiMasterResource.scala
Show resolved
Hide resolved
turboFei
approved these changes
May 9, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2495 +/- ##
==========================================
+ Coverage 40.17% 40.78% +0.61%
==========================================
Files 218 220 +2
Lines 13742 13962 +220
Branches 1214 1241 +27
==========================================
+ Hits 5520 5693 +173
- Misses 7905 7940 +35
- Partials 317 329 +12 ☔ View full report in Codecov by Sentry. |
Contributor
|
Merge to main(v0.5.0) |
pan3793
pushed a commit
that referenced
this pull request
Jul 11, 2024
…ded APIs ### What changes were proposed in this pull request? This PR is a follow up for #2495, fix the media types. ### Why are the changes needed? The media types shown in the swagger UI are not correct. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Before: <img width="1439" alt="image" src="https://github.com/apache/celeborn/assets/6757692/f287c02b-791c-4677-93b7-ac9c5e4ee34f"> After: <img width="1341" alt="image" src="https://github.com/apache/celeborn/assets/6757692/13e5d310-7c97-4872-9496-f9b12113b7ab"> Closes #2616 from turboFei/form_app. Authored-by: Fei Wang <fwang12@ebay.com> Signed-off-by: Cheng Pan <chengpan@apache.org>
pan3793
pushed a commit
that referenced
this pull request
Jul 11, 2024
…ded APIs ### What changes were proposed in this pull request? This PR is a follow up for #2495, fix the media types. ### Why are the changes needed? The media types shown in the swagger UI are not correct. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Before: <img width="1439" alt="image" src="https://github.com/apache/celeborn/assets/6757692/f287c02b-791c-4677-93b7-ac9c5e4ee34f"> After: <img width="1341" alt="image" src="https://github.com/apache/celeborn/assets/6757692/13e5d310-7c97-4872-9496-f9b12113b7ab"> Closes #2616 from turboFei/form_app. Authored-by: Fei Wang <fwang12@ebay.com> Signed-off-by: Cheng Pan <chengpan@apache.org> (cherry picked from commit bd3f823) Signed-off-by: Cheng Pan <chengpan@apache.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Improve parameters, description and document of Celeborn REST API, including:
@FormParaminstead of@QueryParam./excludealigns with document inmonitoring.md.REST APIadds theMethodandParametersto document GET/POST method and corresponding interface.Why are the changes needed?
The parameters, description and document of REST API need to improve after http server refine.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
GA.