You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by "Wangda Tan (Jira)" <ji...@apache.org> on 2020/05/01 22:22:00 UTC
[jira] [Commented] (SUBMARINE-481) Use Swagger to describe and
document submarine RESTful APIs
[ https://issues.apache.org/jira/browse/SUBMARINE-481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17097715#comment-17097715 ]
Wangda Tan commented on SUBMARINE-481:
--------------------------------------
Thanks [~pingsutw],
I just posted some comments to [https://docs.google.com/document/d/1T-NowARlz0EGrsMiAdUmA6af1b_G4bUPu-eKi7nvuk8/edit#heading=h.t713oano4cl4, |https://docs.google.com/document/d/1T-NowARlz0EGrsMiAdUmA6af1b_G4bUPu-eKi7nvuk8/edit#heading=h.t713oano4cl4]
I will let [~sunilg]/[~tangzhankun], etc. to help with further reviews especially how we do implementation by using Swagger.
Swagger 3.0 should be a better choice as we have some recent projects are struggling to upgrade to 3.0. 3.0 has some important features like inheritance support, etc. [https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/]
[~jiwq], do you have any more updates about how much work needed to use the new API? Draft see [https://docs.google.com/document/d/1T-NowARlz0EGrsMiAdUmA6af1b_G4bUPu-eKi7nvuk8/edit#heading=h.t713oano4cl4]
> Use Swagger to describe and document submarine RESTful APIs
> -----------------------------------------------------------
>
> Key: SUBMARINE-481
> URL: https://issues.apache.org/jira/browse/SUBMARINE-481
> Project: Apache Submarine
> Issue Type: Improvement
> Components: Doc
> Reporter: Kevin Su
> Assignee: Kevin Su
> Priority: Major
> Labels: pull-request-available
> Attachments: experiment.yaml, swagger.yaml
>
>
> Follow [JobManagerRestApi.java|https://github.com/apache/submarine/blob/31f9322216307f958a1c3ec79e8a09cb0a5f5b5e/submarine-server/server-core/src/main/java/org/apache/submarine/server/rest/JobManagerRestApi.java#L44] and [Job.java |https://github.com/apache/submarine/blob/master/submarine-server/server-api/src/main/java/org/apache/submarine/server/api/job/Job.java], [submarine-server doc|https://github.com/apache/submarine/tree/master/docs/submarine-server] to define our job API by swagger
> We could copy swagger.ymal to [https://editor.swagger.io/] so that we could automatically generate doc and related client API.
> Anything I miss or something that needs to modify, please let me know
> cc [~leftnoteasy] [~liuxun] [~jiwq] [~tangzhankun]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org