added some notes on query response

stevenferrer · Jun 22, 2020 · 65071d8 · 65071d8
1 parent b6d15ae
commit 65071d8
Showing 1 changed file with 10 additions and 8 deletions.
diff --git a/query/response.go b/query/response.go
@@ -2,18 +2,20 @@ package query
 
 // Response is a query response
 type Response struct {
-	ResponseHeader ResponseHeader         `json:"responseHeader"`
-	Response       ResponseBody           `json:"response,omitempty"`
-	Facets         map[string]interface{} `json:"facets,omitempty"`
-	Error          *Error                 `json:"error,omitempty"`
+	ResponseHeader ResponseHeader `json:"responseHeader"`
+	Response       ResponseBody   `json:"response,omitempty"`
+	// TODO: Extract/unmarshal facet data via tag e.g. solr:"count", solr:"val", etc.
+	Facets map[string]interface{} `json:"facets,omitempty"`
+	Error  *Error                 `json:"error,omitempty"`
 }
 
 // ResponseBody is the response body
 type ResponseBody struct {
-	NumFound int                      `json:"numFound,omitempty"`
-	Start    int                      `json:"start,omitempty"`
-	MaxScore float64                  `json:"maxScore,omitempty"`
-	Docs     []map[string]interface{} `json:"docs,omitempty"`
+	NumFound int     `json:"numFound,omitempty"`
+	Start    int     `json:"start,omitempty"`
+	MaxScore float64 `json:"maxScore,omitempty"`
+	// TODO: Extract/unmarshal facet data via tag e.g. solr:"title", solr:"desc", etc.
+	Docs []map[string]interface{} `json:"docs,omitempty"`
 }
 
 // ResponseHeader is a response header