Skip to content

Improving API description to capture the functionality#13539

Merged
Jackie-Jiang merged 1 commit intoapache:masterfrom
9aman:improving_swagger_API_comment
Jul 9, 2024
Merged

Improving API description to capture the functionality#13539
Jackie-Jiang merged 1 commit intoapache:masterfrom
9aman:improving_swagger_API_comment

Conversation

@9aman
Copy link
Contributor

@9aman 9aman commented Jul 4, 2024

  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.

@codecov-commenter
Copy link

codecov-commenter commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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%) ⬇️
integration <0.01% <ø> (-0.01%) ⬇️
integration1 <0.01% <ø> (-0.01%) ⬇️
integration2 0.00% <ø> (ø)
java-11 62.06% <ø> (+0.35%) ⬆️
java-21 61.95% <ø> (+0.32%) ⬆️
skip-bytebuffers-false 62.08% <ø> (+0.33%) ⬆️
skip-bytebuffers-true 61.92% <ø> (+34.19%) ⬆️
temurin 62.09% <ø> (+0.34%) ⬆️
unittests 62.08% <ø> (+0.34%) ⬆️
unittests1 46.68% <ø> (-0.22%) ⬇️
unittests2 27.65% <ø> (-0.09%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@9aman 9aman force-pushed the improving_swagger_API_comment branch 7 times, most recently from 1678c61 to 07467e5 Compare July 6, 2024 12:05
@9aman 9aman force-pushed the improving_swagger_API_comment branch from 07467e5 to 75699b3 Compare July 8, 2024 05:29
@Jackie-Jiang Jackie-Jiang added the user-experience Related to user experience label Jul 9, 2024
@Jackie-Jiang Jackie-Jiang merged commit fb9f295 into apache:master Jul 9, 2024
@9aman 9aman deleted the improving_swagger_API_comment branch July 10, 2024 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rest-api user-experience Related to user experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants