You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@submarine.apache.org by "Byron Hsu (Jira)" <ji...@apache.org> on 2021/07/12 03:22:00 UTC

[jira] [Created] (SUBMARINE-923) [User] API documentation

Byron Hsu created SUBMARINE-923:
-----------------------------------

             Summary: [User] API documentation
                 Key: SUBMARINE-923
                 URL: https://issues.apache.org/jira/browse/SUBMARINE-923
             Project: Apache Submarine
          Issue Type: Sub-task
            Reporter: Byron Hsu


h3. How to write the documentation

1. Follow the format of Github API ([https://docs.github.com/en/rest/reference/actions]).
 2. For each API endpoint, firstly provide the purpose for this endpoint. (e.g. If the endpoint is "experiment", you can say that experiment API is for submitting and managing distributed ML training jobs.
 3. And for the method in an endpoint, should provide 1. purpose 2. Parameters 3. Samples (in shell format)
h3. Where to check the spec of the API method

1. Refer to the code of RestAPI and trace the variable type in the modal.



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