You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by "Kevin Su (Jira)" <ji...@apache.org> on 2020/04/23 01:22:00 UTC
[jira] [Created] (SUBMARINE-481) Use Swagger to describe and
document submarine RESTful APIs
Kevin Su created SUBMARINE-481:
----------------------------------
Summary: 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
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-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org