Add endpoint info to "cx get api"

Author: deliahu

cli/cmd/get.go

@@ -377,40 +377,50 @@ func describeAPI(name string, resourcesRes *schema.GetResourcesResponse) (string
 		return "", userconfig.ErrorUndefinedResource(name, resource.APIType)
 	}
 
-	api := resourcesRes.Context.APIs[name]
+	ctx := resourcesRes.Context
+	api := ctx.APIs[name]
+	model := ctx.Models[api.ModelName]
 
 	var staleReplicas int32 = 0
 	var ctxAPIStatus *resource.APIStatus = nil
+	var anyAPIStatus *resource.APIStatus = nil
 	for _, apiStatus := range resourcesRes.APIStatuses {
 		if apiStatus.APIName != name {
 			continue
 		}
+		anyAPIStatus = apiStatus
 		if api != nil && apiStatus.ResourceID == api.ID {
 			ctxAPIStatus = apiStatus
 		}
 		staleReplicas += apiStatus.TotalStaleReady()
 	}
 
 	out := titleStr("Summary")
-
-	if groupStatus.ActiveStatus != nil {
-		out += "Endpoint:          " + util.URLJoin(resourcesRes.APIsBaseURL, groupStatus.ActiveStatus.Path) + "\n"
-	}
-
 	out += "Status:            " + groupStatus.Message() + "\n"
-	out += "Created at:        " + util.LocalTimestamp(groupStatus.Start) + "\n"
-
-	if groupStatus.ActiveStatus != nil && groupStatus.ActiveStatus.Start != nil {
-		out += "Refreshed at:      " + util.LocalTimestamp(groupStatus.ActiveStatus.Start) + "\n"
-	}
-
 	if ctxAPIStatus != nil {
 		out += fmt.Sprintf("Updated replicas:  %d/%d ready\n", ctxAPIStatus.ReadyUpdated, ctxAPIStatus.RequestedReplicas)
 	}
-
 	if staleReplicas != 0 {
 		out += fmt.Sprintf("Stale replicas:    %d ready\n", staleReplicas)
 	}
+	out += "Created at:        " + util.LocalTimestamp(groupStatus.Start) + "\n"
+	if groupStatus.ActiveStatus != nil && groupStatus.ActiveStatus.Start != nil {
+		out += "Refreshed at:      " + util.LocalTimestamp(groupStatus.ActiveStatus.Start) + "\n"
+	}
+
+	out += titleStr("Endpoint")
+	var samplePlaceholderFields []string
+	for _, colName := range ctx.RawColumnInputNames(model) {
+		column := ctx.GetColumn(colName)
+		columnType := userconfig.ColumnTypeFromString(column.GetType())
+		fieldStr := `"` + colName + `": ` + columnType.JSONPlaceholder()
+		samplePlaceholderFields = append(samplePlaceholderFields, fieldStr)
+	}
+	samplesPlaceholderStr := `{ "samples": [ { ` + strings.Join(samplePlaceholderFields, ", ") + " } ] }"
+	out += "URL:      " + util.URLJoin(resourcesRes.APIsBaseURL, anyAPIStatus.Path) + "\n"
+	out += "Method:   POST\n"
+	out += `Header:   "Content-Type: application/json"` + "\n"
+	out += "Payload:  " + samplesPlaceholderStr + "\n"
 
 	if api != nil {
 		out += resourceStr(api.API)

docs/quick-start.md

@@ -560,25 +560,33 @@ $ cortex get api iris-type
 Summary
 -------
 
-Endpoint:         https://a84607a462f1811e9aa3b020abd0a844-645332984.us-west-2.elb.amazonaws.com/iris/iris-type
-Status:           ready
-Created at:       2019-02-14 14:57:04 PST
-Refreshed at:     2019-02-14 14:57:35 PST
-Updated replicas: 1/1 ready
+Status:            ready
+Updated replicas:  1/1 ready
+Created at:        2019-02-14 14:57:04 PST
+Refreshed at:      2019-02-14 14:57:35 PST
+
+--------
+Endpoint
+--------
+
+URL:      https://a84607a462f1811e9aa3b020abd0a844-645332984.us-west-2.elb.amazonaws.com/iris/iris-type
+Method:   POST
+Header:   "Content-Type: application/json"
+Payload:  { "samples": [ { "petal_length": FLOAT, "petal_width": FLOAT, "sepal_length": FLOAT, "sepal_width": FLOAT } ] }
 
 -------------
 Configuration
 -------------
 
 {
- "name": "iris-type",
- "model_name": "dnn",
- "compute": {
-   "replicas": 1,
-   "cpu": <null>,
-   "mem": <null>
- },
- "tags": {}
+  "name": "iris-type",
+  "model_name": "dnn",
+  "compute": {
+    "replicas": 1,
+    "cpu": <null>,
+    "mem": <null>
+  },
+  "tags": {}
 }
 ```
 

pkg/api/context/columns.go

@@ -31,6 +31,7 @@ type Column interface {
 	ComputedResource
 	GetType() string
 	IsRaw() bool
+	GetInputRawColumnNames() []string
 }
 
 func (ctx *Context) Columns() Columns {

pkg/api/context/dependencies.go

@@ -87,7 +87,7 @@ func (ctx *Context) aggregatesDependencies(aggregate *Aggregate) map[string]bool
 	for _, pythonPackage := range ctx.PythonPackages {
 		dependencies[pythonPackage.GetID()] = true
 	}
-	for rawColumnName := range rawColumnNames {
+	for _, rawColumnName := range rawColumnNames {
 		rawColumn := ctx.RawColumns[rawColumnName]
 		dependencies[rawColumn.GetID()] = true
 	}
@@ -102,7 +102,7 @@ func (ctx *Context) transformedColumnDependencies(transformedColumn *Transformed
 	}
 
 	rawColumnNames := transformedColumn.InputColumnNames()
-	for rawColumnName := range rawColumnNames {
+	for _, rawColumnName := range rawColumnNames {
 		rawColumn := ctx.RawColumns[rawColumnName]
 		dependencies[rawColumn.GetID()] = true
 	}

pkg/api/context/models.go

@@ -17,10 +17,13 @@ limitations under the License.
 package context
 
 import (
+	"sort"
+
 	"github.com/cortexlabs/cortex/pkg/api/resource"
 	s "github.com/cortexlabs/cortex/pkg/api/strings"
 	"github.com/cortexlabs/cortex/pkg/api/userconfig"
 	"github.com/cortexlabs/cortex/pkg/utils/errors"
+	"github.com/cortexlabs/cortex/pkg/utils/sets/strset"
 )
 
 type Models map[string]*Model
@@ -91,3 +94,14 @@ func ValidateModelTargetType(targetDataTypeStr string, modelType string) error {
 
 	return errors.New(s.ErrInvalidStr(modelType, "classification", "regression")) // unexpected
 }
+
+func (ctx *Context) RawColumnInputNames(model *Model) []string {
+	rawColumnInputNames := strset.New()
+	for _, colName := range model.FeatureColumns {
+		col := ctx.GetColumn(colName)
+		rawColumnInputNames.Add(col.GetInputRawColumnNames()...)
+	}
+	list := rawColumnInputNames.List()
+	sort.Strings(list)
+	return list
+}

pkg/api/context/raw_columns.go

@@ -86,3 +86,15 @@ func (rawColumns RawColumns) ColumnInputsID(columnInputValues map[string]interfa
 func (rawColumns RawColumns) ColumnInputsIDWithTags(columnInputValues map[string]interface{}) string {
 	return rawColumns.columnInputsID(columnInputValues, true)
 }
+
+func (rawColumn *RawIntColumn) GetInputRawColumnNames() []string {
+	return []string{rawColumn.GetName()}
+}
+
+func (rawColumn *RawFloatColumn) GetInputRawColumnNames() []string {
+	return []string{rawColumn.GetName()}
+}
+
+func (rawColumn *RawStringColumn) GetInputRawColumnNames() []string {
+	return []string{rawColumn.GetName()}
+}

pkg/api/context/transformed_columns.go

@@ -57,3 +57,7 @@ func (transformedColumns TransformedColumns) OneByID(id string) *TransformedColu
 	}
 	return nil
 }
+
+func (transformedColumn *TransformedColumn) GetInputRawColumnNames() []string {
+	return transformedColumn.InputColumnNames()
+}

pkg/api/userconfig/aggregates.go

@@ -17,6 +17,8 @@ limitations under the License.
 package userconfig
 
 import (
+	"sort"
+
 	"github.com/cortexlabs/cortex/pkg/api/resource"
 	cr "github.com/cortexlabs/cortex/pkg/utils/configreader"
 	"github.com/cortexlabs/cortex/pkg/utils/util"
@@ -89,7 +91,8 @@ func (aggregates Aggregates) Get(name string) *Aggregate {
 	return nil
 }
 
-func (aggregate *Aggregate) InputColumnNames() map[string]bool {
-	inputs, _ := util.FlattenAllStrValuesAsSet(aggregate.Inputs.Columns)
+func (aggregate *Aggregate) InputColumnNames() []string {
+	inputs, _ := util.FlattenAllStrValues(aggregate.Inputs.Columns)
+	sort.Strings(inputs)
 	return inputs
 }

pkg/api/userconfig/column_type.go

@@ -41,6 +41,16 @@ var columnTypes = []string{
 	"STRING_LIST_COLUMN",
 }
 
+var columnJSONPlaceholders = []string{
+	"_",
+	"INT",
+	"FLOAT",
+	"\"STRING\"",
+	"[INT]",
+	"[FLOAT]",
+	"[\"STRING\"]",
+}
+
 func ColumnTypeFromString(s string) ColumnType {
 	for i := 0; i < len(columnTypes); i++ {
 		if s == columnTypes[i] {
@@ -58,6 +68,10 @@ func (t ColumnType) String() string {
 	return columnTypes[t]
 }
 
+func (t ColumnType) JSONPlaceholder() string {
+	return columnJSONPlaceholders[t]
+}
+
 // MarshalText satisfies TextMarshaler
 func (t ColumnType) MarshalText() ([]byte, error) {
 	return []byte(t.String()), nil

pkg/api/userconfig/transformed_columns.go

@@ -17,6 +17,8 @@ limitations under the License.
 package userconfig
 
 import (
+	"sort"
+
 	"github.com/cortexlabs/cortex/pkg/api/resource"
 	cr "github.com/cortexlabs/cortex/pkg/utils/configreader"
 	"github.com/cortexlabs/cortex/pkg/utils/util"
@@ -94,7 +96,8 @@ func (transformedColumns TransformedColumns) Get(name string) *TransformedColumn
 	return nil
 }
 
-func (transformedColumn *TransformedColumn) InputColumnNames() map[string]bool {
-	inputs, _ := util.FlattenAllStrValuesAsSet(transformedColumn.Inputs.Columns)
+func (transformedColumn *TransformedColumn) InputColumnNames() []string {
+	inputs, _ := util.FlattenAllStrValues(transformedColumn.Inputs.Columns)
+	sort.Strings(inputs)
 	return inputs
 }