docs: update api docs

Signed-off-by: hongming <talonwan@yunify.com>
This commit is contained in:
hongming
2019-07-05 18:18:57 +08:00
parent 71da84674d
commit e0d5a84f5e
2 changed files with 6 additions and 6 deletions

View File

@@ -41,7 +41,7 @@ type Application struct {
Name string `json:"name" description:"application name"`
RepoName string `json:"repoName" description:"repo name"`
Runtime string `json:"namespace" description:"namespace"`
RuntimeId string `json:"runtime_id" description:"runtime id"`
RuntimeId string `json:"runtime_id" description:"originates from OpenPitrix and represents k8s namespace, it's the value of the annotation in each namespace, e.g. openpitrix_runtime: runtime-xEg1LGZQYN93"`
Version string `json:"version" description:"application version"`
VersionId string `json:"version_id" description:"application version id"`
Status string `json:"status" description:"application status"`

View File

@@ -102,14 +102,14 @@ type repoList struct {
}
type CreateClusterRequest struct {
AppId string `json:"app_id"`
VersionId string `json:"version_id"`
RuntimeId string `json:"runtime_id"`
Conf string `json:"conf"`
AppId string `json:"app_id" description:"ID of app to run in cluster, e.g. app-AA3A3y3zEgEM"`
VersionId string `json:"version_id" description:"app version, e.g. appv-154gXYx5RKRp"`
RuntimeId string `json:"runtime_id" description:"ID of runtime, e.g. runtime-wWwXL0LzWqEr"`
Conf string `json:"conf" description:"conf a json string, include cpu, memory info of cluster"`
}
type DeleteClusterRequest struct {
ClusterId []string `json:"cluster_id"`
ClusterId []string `json:"cluster_id" description:"cluster ID"`
}
func GetAppInfo(appId string) (string, string, string, error) {