From eb4837d285a83f70d5551fb8698827629c1082b5 Mon Sep 17 00:00:00 2001 From: kevin85421 Date: Sat, 25 Jul 2020 18:20:29 +0800 Subject: [PATCH] SUBMARINE-578. Update /docs/userdocs/k8s/api/experiment.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### What is this PR for? Update /docs/userdocs/k8s/api/experiment.md In the document, every ```curl``` command cannot work properly. For example, I execute ```curl -X GET http://127.0.0.1/api/v1/experiment``` to list all experiments, and the response is "404 Not Found". Therefore, I modify ```127.0.0.1``` to ```127.0.0.1:8080```, and get the expected response as shown in the following figure. 截圖 2020-07-25 下午6 33 56 ### What type of PR is it? Documentation ### Todos ### What is the Jira issue? https://issues.apache.org/jira/browse/SUBMARINE-578 ### How should this be tested? * Step1: Follow the [document](https://github.com/apache/submarine/blob/master/docs/userdocs/k8s/helm.md) to deploy Submarine on k8s. * Step2: Port forward ```sh kubectl port-forward svc/submarine-server 8080:8080 ``` * Step3: Execute the following curl commands ``` # Get "404 Not Found" curl -X GET http://127.0.0.1/api/v1/experiment # Get expected response curl -X GET http://127.0.0.1:8080/api/v1/experiment ``` ### Screenshots (if appropriate) 截圖 2020-07-25 下午6 33 56 ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? No Author: kevin85421 Closes #359 from kevin85421/SUBMARINE-578 and squashes the following commits: 8b499da [kevin85421] SUBMARINE-578. Update experiment.md --- docs/userdocs/k8s/api/experiment.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/userdocs/k8s/api/experiment.md b/docs/userdocs/k8s/api/experiment.md index 892db6ae12..132f60622d 100644 --- a/docs/userdocs/k8s/api/experiment.md +++ b/docs/userdocs/k8s/api/experiment.md @@ -52,7 +52,7 @@ curl -X POST -H "Content-Type: application/json" -d ' } } } -' http://127.0.0.1/api/v1/experiment +' http://127.0.0.1:8080/api/v1/experiment ``` **Example Response:** @@ -99,7 +99,7 @@ curl -X POST -H "Content-Type: application/json" -d ' **Example Request:** ```sh -curl -X GET http://127.0.0.1/api/v1/experiment +curl -X GET http://127.0.0.1:8080/api/v1/experiment ``` **Example Response:** @@ -179,7 +179,7 @@ curl -X GET http://127.0.0.1/api/v1/experiment **Example Request:** ```sh -curl -X GET http://127.0.0.1/api/v1/experiment/experiment_1592057447228_0001 +curl -X GET http://127.0.0.1:8080/api/v1/experiment/experiment_1592057447228_0001 ``` **Example Response:** @@ -251,7 +251,7 @@ curl -X PATCH -H "Content-Type: application/json" -d ' } } } -' http://127.0.0.1/api/v1/experiment/experiment_1592057447228_0001 +' http://127.0.0.1:8080/api/v1/experiment/experiment_1592057447228_0001 ``` **Example Response:** @@ -292,7 +292,7 @@ curl -X PATCH -H "Content-Type: application/json" -d ' **Example Request:** ```sh -curl -X DELETE http://127.0.0.1/api/v1/experiment/experiment_1592057447228_0001 +curl -X DELETE http://127.0.0.1:8080/api/v1/experiment/experiment_1592057447228_0001 ``` **Example Response:** @@ -339,7 +339,7 @@ curl -X DELETE http://127.0.0.1/api/v1/experiment/experiment_1592057447228_0001 **Example Request:** ```sh -curl -X GET http://127.0.0.1/api/v1/experiment/logs +curl -X GET http://127.0.0.1:8080/api/v1/experiment/logs ``` **Example Response:** @@ -382,7 +382,7 @@ curl -X GET http://127.0.0.1/api/v1/experiment/logs **Example Request:** ```sh -curl -X GET http://127.0.0.1/api/v1/experiment/logs/experiment_1589199154923_0002 +curl -X GET http://127.0.0.1:8080/api/v1/experiment/logs/experiment_1589199154923_0002 ``` **Example Response:**