[SUBMARINE-923] [User] API documentation

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.7.0
• Labels: pull-request-available
• Assignee: Jhan-Shuo Liu
• Reporter: Byron Hsu
• Created: 12/Jul/21 03:21
• Updated: 14/Jul/21 06:14
• Resolved: 14/Jul/21 06:14

Description

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)

Where to check the spec of the API method

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

Issue Links

• links to: GitHub Pull Request #671