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/07/29 10:17:24 UTC

[GitHub] [dolphinscheduler] fuchanghai opened a new issue, #11208: [Improvement][swagger] Now the interface document returns only the generic template

fuchanghai opened a new issue, #11208:
URL: https://github.com/apache/dolphinscheduler/issues/11208

   ### Search before asking
   
   - [X] I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found no similar feature requirement.
   
   
   ### Description
   
   <img width="1440" alt="截屏2022-07-29 18 10 33" src="https://user-images.githubusercontent.com/33984497/181737439-1ce4ce2a-a1d1-4265-8d3c-f821b7caf84c.png">
   If the developer is a front end, he wants to see the data structure in 'data'
   
   If the response attribute of the annotation @ApiOperation is used, the interface document can see the data structure of data, but cannot see the general return template. Can you give some advice? Need a discussion tag?
   @SbloodyS @EricGao888 
   
   ### Are you willing to submit a PR?
   
   - [ ] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
   


-- 
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.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [dolphinscheduler] fuchanghai commented on issue #11208: [Improvement][swagger] Now the interface document returns only the generic template

Posted by GitBox <gi...@apache.org>.
fuchanghai commented on issue #11208:
URL: https://github.com/apache/dolphinscheduler/issues/11208#issuecomment-1200793508

   @SbloodyS Although after your modification, I can only see the unified return structure。
   ```json
   
   {
   	"code": 0,
   	"data": {},
   	"failed": true,
   	"msg": "",
   	"success": true
   }
   ```
    i mean as a ui,even if some default values ​​of f12 are null, the front end cannot judge the type of the parameter, nor does it know the meaning of each attribute of the object in 'data'.so why i open this issue


-- 
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] github-actions[bot] commented on issue #11208: [Improvement][swagger] Now the interface document returns only the generic template

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #11208:
URL: https://github.com/apache/dolphinscheduler/issues/11208#issuecomment-1199157636

   ### Search before asking
   
   - [X] I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found no similar feature requirement.
   
   
   ### Description
   
   <img width="1440" alt="截屏2022-07-29 18 10 33" src="https://user-images.githubusercontent.com/33984497/181737439-1ce4ce2a-a1d1-4265-8d3c-f821b7caf84c.png">
   If the developer is a front end, he wants to see the data structure in 'data'
   
   If the response attribute of the annotation @ApiOperation is used, the interface document can see the data structure of data, but cannot see the general return template. Can you give some advice? Need a discussion tag?
   @SbloodyS @EricGao888 
   
   ### Are you willing to submit a PR?
   
   - [ ] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)


-- 
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] github-actions[bot] commented on issue #11208: [Improvement][swagger] Now the interface document returns only the generic template

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #11208:
URL: https://github.com/apache/dolphinscheduler/issues/11208#issuecomment-1199157841

   Thank you for your feedback, we have received your issue, Please wait patiently for a reply.
   * In order for us to understand your request as soon as possible, please provide detailed information、version or pictures.
   * If you haven't received a reply for a long time, you can [join our slack](https://s.apache.org/dolphinscheduler-slack) and send your question to channel `#troubleshooting`


-- 
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] fuchanghai commented on issue #11208: [Improvement][swagger] Now the interface document returns only the generic template

Posted by GitBox <gi...@apache.org>.
fuchanghai commented on issue #11208:
URL: https://github.com/apache/dolphinscheduler/issues/11208#issuecomment-1200812450

   @SbloodyS  you are so smart,thx


-- 
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 issue #11208: [Improvement][swagger] Now the interface document returns only the generic template

Posted by GitBox <gi...@apache.org>.
SbloodyS commented on issue #11208:
URL: https://github.com/apache/dolphinscheduler/issues/11208#issuecomment-1200133309

   This is one of the reasons why we refactor the API in #10257. Currently, you can debug by opening F12 in the page to view the format of specific parameters.


-- 
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 issue #11208: [Improvement][swagger] Now the interface document returns only the generic template

Posted by GitBox <gi...@apache.org>.
SbloodyS commented on issue #11208:
URL: https://github.com/apache/dolphinscheduler/issues/11208#issuecomment-1200798201

   You can find the data structure through swagger ui after refactor to v2 api. For more detail you can take a look at #10301.


-- 
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] fuchanghai closed issue #11208: [Improvement][swagger] Now the interface document returns only the generic template

Posted by GitBox <gi...@apache.org>.
fuchanghai closed issue #11208: [Improvement][swagger] Now the interface document returns only the generic template
URL: https://github.com/apache/dolphinscheduler/issues/11208


-- 
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