pinot icon indicating copy to clipboard operation
pinot copied to clipboard

Improving API description to capture the functionality

Open 9aman opened this issue 1 year ago • 1 comments

  1. The current description of the API @Path("/tasks/subtask/{taskName}/config") is minimal and doesn't capture all the actions performed by the API.
  2. Improve the API description and capture how the API handles the absence of query params internally.
  3. This will help reduce ambiguity for the users.

9aman avatar Jul 04 '24 06:07 9aman

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 62.09%. Comparing base (59551e4) to head (75699b3). Report is 717 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master   #13539      +/-   ##
============================================
+ Coverage     61.75%   62.09%   +0.34%     
+ Complexity      207      198       -9     
============================================
  Files          2436     2557     +121     
  Lines        133233   140887    +7654     
  Branches      20636    21855    +1219     
============================================
+ Hits          82274    87481    +5207     
- Misses        44911    46791    +1880     
- Partials       6048     6615     +567     
Flag Coverage Δ
custom-integration1 <0.01% <ø> (-0.01%) :arrow_down:
integration <0.01% <ø> (-0.01%) :arrow_down:
integration1 <0.01% <ø> (-0.01%) :arrow_down:
integration2 0.00% <ø> (ø)
java-11 62.06% <ø> (+0.35%) :arrow_up:
java-21 61.95% <ø> (+0.32%) :arrow_up:
skip-bytebuffers-false 62.08% <ø> (+0.33%) :arrow_up:
skip-bytebuffers-true 61.92% <ø> (+34.19%) :arrow_up:
temurin 62.09% <ø> (+0.34%) :arrow_up:
unittests 62.08% <ø> (+0.34%) :arrow_up:
unittests1 46.68% <ø> (-0.22%) :arrow_down:
unittests2 27.65% <ø> (-0.09%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Jul 04 '24 06:07 codecov-commenter