You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2022/05/30 07:34:09 UTC
[GitHub] [dolphinscheduler] SbloodyS opened a new pull request, #10292: [Doc] Fix api standard error
SbloodyS opened a new pull request, #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292
<!--Thanks very much for contributing to Apache DolphinScheduler. Please review https://dolphinscheduler.apache.org/en-us/community/development/pull-request.html before opening a pull request.-->
## Purpose of the pull request
Fix api standard error, as we discuss in https://github.com/apache/dolphinscheduler/issues/10257#issuecomment-1140444919
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] devosend commented on pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
devosend commented on PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#issuecomment-1157490954
Should this pr be marked as milestone 4.0.0-alpha? @SbloodyS
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#issuecomment-1140811582
Looking good, but could you also add `patch` requests in our API document? according https://github.com/apache/dolphinscheduler/issues/10257#issuecomment-1139412365
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#issuecomment-1158858432
> > Should this pr be marked as milestone 4.0.0-alpha? @SbloodyS
>
> I think it can be released in the next version since this is a bug in our documentation. Not feature.
Agree with that
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] SbloodyS commented on pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
SbloodyS commented on PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#issuecomment-1140812674
> Looking good, but could you also add `patch` requests in our API document? according [#10257 (comment)](https://github.com/apache/dolphinscheduler/issues/10257#issuecomment-1139412365)
Sure. I'll add it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] devosend commented on pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
devosend commented on PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#issuecomment-1157496423
>
> > Should this pr be marked as milestone 4.0.0-alpha? @SbloodyS
>
> I think it can be released in the next version since this is a bug in our documentation. Not feature.
Ok, I will mark it as 3.0.0-beta-2
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] SbloodyS commented on pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
SbloodyS commented on PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#issuecomment-1157492915
> Should this pr be marked as milestone 4.0.0-alpha? @SbloodyS
I think it can be released in the next version since this is a bug in our documentation. Not feature.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] SbloodyS commented on a diff in pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
SbloodyS commented on code in PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#discussion_r884525599
##########
docs/docs/en/development/api-standard.md:
##########
@@ -71,20 +71,28 @@ Use URI to locate the resource, use DELETE to indicate delete.
+ delete an `alert-group`
```
Method: DELETE
-/api/dolphinscheduler/alter-groups/{alterGroupId}
+/dolphinscheduler/alter-groups/{alterGroupId}
```
+ batch deletion: batch delete the id array，we should use POST. **（Do not use the DELETE method, because the body of the DELETE request has no semantic meaning, and it is possible that some gateways, proxies, and firewalls will directly strip off the request body after receiving the DELETE request.）**
```
Method: POST
-/api/dolphinscheduler/alter-groups/batch-delete
+/dolphinscheduler/alter-groups/batch-delete
```
-### ⑤ Others
+### ⑤ Partial Modifications -PATCH
+Use URI to locate the resource, use PATCH to partial modifications.
+
+```
+Method: PATCH
+/dolphinscheduler/alter-groups/{alterGroupId}
Review Comment:
Since there is no actual interface requested by ```PATCH```. I temporarily use a nonexistent interface as an example.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] SbloodyS commented on pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
SbloodyS commented on PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#issuecomment-1140806084
@zhongjiajie PTAL.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292#discussion_r884538729
##########
docs/docs/en/development/api-standard.md:
##########
@@ -71,20 +71,28 @@ Use URI to locate the resource, use DELETE to indicate delete.
+ delete an `alert-group`
```
Method: DELETE
-/api/dolphinscheduler/alter-groups/{alterGroupId}
+/dolphinscheduler/alter-groups/{alterGroupId}
```
+ batch deletion: batch delete the id array，we should use POST. **（Do not use the DELETE method, because the body of the DELETE request has no semantic meaning, and it is possible that some gateways, proxies, and firewalls will directly strip off the request body after receiving the DELETE request.）**
```
Method: POST
-/api/dolphinscheduler/alter-groups/batch-delete
+/dolphinscheduler/alter-groups/batch-delete
```
-### ⑤ Others
+### ⑤ Partial Modifications -PATCH
+Use URI to locate the resource, use PATCH to partial modifications.
+
+```
+Method: PATCH
+/dolphinscheduler/alter-groups/{alterGroupId}
Review Comment:
I do not know before you mention it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie merged pull request #10292: [Doc] Fix api standard error
Posted by GitBox <gi...@apache.org>.
zhongjiajie merged PR #10292:
URL: https://github.com/apache/dolphinscheduler/pull/10292
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org