Skip to content
This repository has been archived by the owner on Jul 10, 2024. It is now read-only.

Commit

Permalink
SUBMARINE-578. Update /docs/userdocs/k8s/api/experiment.md
Browse files Browse the repository at this point in the history
### 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.
<img width="761" alt="截圖 2020-07-25 下午6 33 56" src="https://user-images.githubusercontent.com/20109646/88455124-6a813600-cea5-11ea-9f67-9f6dbe5bcb84.png">

### 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)
<img width="761" alt="截圖 2020-07-25 下午6 33 56" src="https://user-images.githubusercontent.com/20109646/88455124-6a813600-cea5-11ea-9f67-9f6dbe5bcb84.png">

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: kevin85421 <b03901153@ntu.edu.tw>

Closes #359 from kevin85421/SUBMARINE-578 and squashes the following commits:

8b499da [kevin85421] SUBMARINE-578. Update experiment.md
  • Loading branch information
kevin85421 authored and xunliu committed Jul 27, 2020
1 parent 99ba038 commit eb4837d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/userdocs/k8s/api/experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
Expand Down Expand Up @@ -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:**
Expand Down Expand Up @@ -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:**
Expand Down Expand Up @@ -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:**
Expand Down Expand Up @@ -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:**
Expand Down Expand Up @@ -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:**
Expand Down Expand Up @@ -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:**
Expand Down

0 comments on commit eb4837d

Please sign in to comment.