[ 
https://issues.apache.org/jira/browse/SUBMARINE-481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17091123#comment-17091123
 ] 

Kevin Su commented on SUBMARINE-481:
------------------------------------

I used the Swagger editor to write swagger.yaml. I will try to add annotations 
in our code.

> 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
>            Priority: Major
>         Attachments: 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-unsubscr...@submarine.apache.org
For additional commands, e-mail: dev-h...@submarine.apache.org

Reply via email to