You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by li...@apache.org on 2020/07/31 01:22:37 UTC
[submarine] branch master updated: SUBMARINE-565. Documentation for
Environment Management REST API
This is an automated email from the ASF dual-hosted git repository.
liuxun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 76a236a SUBMARINE-565. Documentation for Environment Management REST API
76a236a is described below
commit 76a236a63d28ffe2864e5424f09760a3568a84a3
Author: Manikandan R <ma...@caastle.com>
AuthorDate: Tue Jul 21 22:36:06 2020 +0530
SUBMARINE-565. Documentation for Environment Management REST API
### What is this PR for?
Documentation for Environment Management REST API's
### What type of PR is it?
Documentation
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-565
### How should this be tested?
* First time? Setup Travis CI as described on https://submarine.apache.org/contribution/contributions.html#continuous-integration
* Strongly recommended: add automated unit tests for any new or changed behavior
* Outline any manual steps to test the PR here.
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? Yes/No
* Is there breaking changes for older versions? Yes/No
* Does this needs documentation? Yes/No
Author: Manikandan R <ma...@caastle.com>
Closes #348 from manirajv06/SUBMARINE-565 and squashes the following commits:
4e1f959 [Manikandan R] Addressed review comments
9ca3396 [Manikandan R] Updated experiment doc with respect to environment management
34bd1e3 [Manikandan R] Documentation for Environment Management REST API's
---
docs/userdocs/k8s/api/environment.md | 10 +++++-----
docs/userdocs/k8s/api/experiment.md | 2 +-
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/userdocs/k8s/api/environment.md b/docs/userdocs/k8s/api/environment.md
index 5663d46..1b4138d 100644
--- a/docs/userdocs/k8s/api/environment.md
+++ b/docs/userdocs/k8s/api/environment.md
@@ -42,7 +42,7 @@ curl -X POST -H "Content-Type: application/json" -d '
"anaconda-navigator=1.9.12=py37_0"]
}
}
-' http://127.0.0.1/api/v1/environment
+' http://127.0.0.1:8080/api/v1/environment
```
**Example Response:**
@@ -75,7 +75,7 @@ curl -X POST -H "Content-Type: application/json" -d '
**Example Request:**
```sh
-curl -X GET http://127.0.0.1/api/v1/environment
+curl -X GET http://127.0.0.1:8080/api/v1/environment
```
**Example Response:**
@@ -123,7 +123,7 @@ curl -X GET http://127.0.0.1/api/v1/environment
**Example Request:**
```sh
-curl -X GET http://127.0.0.1/api/v1/environment/my-submarine-env
+curl -X GET http://127.0.0.1:8080/api/v1/environment/my-submarine-env
```
**Example Response:**
@@ -168,7 +168,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '
"alabaster=0.7.12=py37_0"]
}
}
-' http://127.0.0.1/api/v1/environment/my-submarine-env
+' http://127.0.0.1:8080/api/v1/environment/my-submarine-env
```
**Example Response:**
@@ -201,7 +201,7 @@ curl -X PATCH -H "Content-Type: application/json" -d '
**Example Request:**
```sh
-curl -X DELETE http://127.0.0.1/api/v1/environment/my-submarine-env
+curl -X DELETE http://127.0.0.1:8080/api/v1/environment/my-submarine-env
```
**Example Response:**
diff --git a/docs/userdocs/k8s/api/experiment.md b/docs/userdocs/k8s/api/experiment.md
index 1501169..835cc48 100644
--- a/docs/userdocs/k8s/api/experiment.md
+++ b/docs/userdocs/k8s/api/experiment.md
@@ -124,7 +124,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
```
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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org