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

SUBMARINE-750. Replace port 8080 with port 32080 in API example #524

Merged
kevin85421 merged 2 commits into from
Mar 3, 2021
Merged

SUBMARINE-750. Replace port 8080 with port 32080 in API example #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad29d38
SUBMARINE-750. Replace port 8080 with 32080
jeff-901 Feb 26, 2021
8049856
SUBMARINE-750. Replace port 8080 with 32080
jeff-901 Feb 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions website/docs/api/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ curl -X POST -H "Content-Type: application/json" -d '
"anaconda-navigator=1.9.12=py37_0"]
}
}
' http://127.0.0.1:8080/api/v1/environment
' http://127.0.0.1:32080/api/v1/environment
```

**Example Response:**
Expand Down Expand Up @@ -77,7 +77,7 @@ curl -X POST -H "Content-Type: application/json" -d '

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/environment
curl -X GET http://127.0.0.1:32080/api/v1/environment
```

**Example Response:**
Expand Down Expand Up @@ -125,7 +125,7 @@ curl -X GET http://127.0.0.1:8080/api/v1/environment

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/environment/my-submarine-env
curl -X GET http://127.0.0.1:32080/api/v1/environment/my-submarine-env
```

**Example Response:**
Expand Down Expand Up @@ -170,7 +170,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '
"alabaster=0.7.12=py37_0"]
}
}
' http://127.0.0.1:8080/api/v1/environment/my-submarine-env
' http://127.0.0.1:32080/api/v1/environment/my-submarine-env
```

**Example Response:**
Expand Down Expand Up @@ -203,7 +203,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '

**Example Request:**
```sh
curl -X DELETE http://127.0.0.1:8080/api/v1/environment/my-submarine-env
curl -X DELETE http://127.0.0.1:32080/api/v1/environment/my-submarine-env
```

**Example Response:**
Expand Down
12 changes: 6 additions & 6 deletions website/docs/api/experiment-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ curl -X POST -H "Content-Type: application/json" -d '
}
}
}
' http://127.0.0.1:8080/api/v1/template
' http://127.0.0.1:32080/api/v1/template
```


Expand All @@ -138,15 +138,15 @@ curl -X POST -H "Content-Type: application/json" -d '

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/template
curl -X GET http://127.0.0.1:32080/api/v1/template
```

### Get experiment template
`GET /api/v1/template/{name}`

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
curl -X GET http://127.0.0.1:32080/api/v1/template/my-tf-mnist-template
```


Expand Down Expand Up @@ -202,7 +202,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '
}
}
}
' http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
' http://127.0.0.1:32080/api/v1/template/my-tf-mnist-template
```

> "description", "parameters", "experimentSpec", "author" etc can be updated using this API.
Expand All @@ -215,7 +215,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '

**Example Request:**
```sh
curl -X DELETE http://127.0.0.1:8080/api/v1/template/my-tf-mnist-template
curl -X DELETE http://127.0.0.1:32080/api/v1/template/my-tf-mnist-template
```


Expand All @@ -233,5 +233,5 @@ curl -X POST -H "Content-Type: application/json" -d '
"experiment_name":"newexperiment1"
}
}
' http://127.0.0.1:8080/api/v1/experiment/my-tf-mnist-template
' http://127.0.0.1:32080/api/v1/experiment/my-tf-mnist-template
```
16 changes: 8 additions & 8 deletions website/docs/api/experiment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ curl -X POST -H "Content-Type: application/json" -d '
}
}
}
' http://127.0.0.1:8080/api/v1/experiment
' http://127.0.0.1:32080/api/v1/experiment
```

**Example Response:**
Expand Down Expand Up @@ -126,7 +126,7 @@ curl -X POST -H "Content-Type: application/json" -d '
}
}
}
' http://127.0.0.1:8080/api/v1/experiment
' http://127.0.0.1:32080/api/v1/experiment
```
Above example assume environment "my-submarine-env" already exists in Submarine. Please refer Environment API Reference doc to Create/Update/Delete/List Environment REST API's

Expand Down Expand Up @@ -174,7 +174,7 @@ Above example assume environment "my-submarine-env" already exists in Submarine.

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/experiment
curl -X GET http://127.0.0.1:32080/api/v1/experiment
```

**Example Response:**
Expand Down Expand Up @@ -254,7 +254,7 @@ curl -X GET http://127.0.0.1:8080/api/v1/experiment

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/experiment/experiment_1592057447228_0001
curl -X GET http://127.0.0.1:32080/api/v1/experiment/experiment_1592057447228_0001
```

**Example Response:**
Expand Down Expand Up @@ -326,7 +326,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '
}
}
}
' http://127.0.0.1:8080/api/v1/experiment/experiment_1592057447228_0001
' http://127.0.0.1:32080/api/v1/experiment/experiment_1592057447228_0001
```

**Example Response:**
Expand Down Expand Up @@ -367,7 +367,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '

**Example Request:**
```sh
curl -X DELETE http://127.0.0.1:8080/api/v1/experiment/experiment_1592057447228_0001
curl -X DELETE http://127.0.0.1:32080/api/v1/experiment/experiment_1592057447228_0001
```

**Example Response:**
Expand Down Expand Up @@ -414,7 +414,7 @@ curl -X DELETE http://127.0.0.1:8080/api/v1/experiment/experiment_1592057447228_

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/experiment/logs
curl -X GET http://127.0.0.1:32080/api/v1/experiment/logs
```

**Example Response:**
Expand Down Expand Up @@ -457,7 +457,7 @@ curl -X GET http://127.0.0.1:8080/api/v1/experiment/logs

**Example Request:**
```sh
curl -X GET http://127.0.0.1:8080/api/v1/experiment/logs/experiment_1589199154923_0002
curl -X GET http://127.0.0.1:32080/api/v1/experiment/logs/experiment_1589199154923_0002
```

**Example Response:**
Expand Down