[
https://issues.apache.org/jira/browse/SUBMARINE-481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17100633#comment-17100633
]
Zhankun Tang edited comment on SUBMARINE-481 at 5/6/20, 10:31 AM:
------------------------------------------------------------------
[~pingsutw], thanks for the hand-written "experiment.yaml" spec! One doubt, I
saw the PR-271 doesn't use swagger core version newer than 2.0.3. Can we update
the swagger core dependency version to "2.1.1" so that it will generate
openAPI3 compatibility spec?
How about this? After we merge the PR-271 and let [~jiwq] continue the "job->
experiment" refactoring based on the new experiment spec. In the meantime, we
continue the spec details discussion here.
[~wangda], [~liuxun] thoughts?
was (Author: tangzhankun):
[~pingsutw], thanks for the hand-written "experiment.yaml" spec!
How about this? We merge the PR-271 and let [~jiwq] continue the "job->
experiment" refactoring based on the new experiment spec.
[~wangda], [~liuxun] thoughts?
> 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: [email protected]
For additional commands, e-mail: [email protected]
