refine api docs

Signed-off-by: huanggze <loganhuang@yunify.com>
This commit is contained in:
huanggze
2019-07-02 16:18:09 +08:00
parent 97195547b2
commit 2530dbaf4e
5 changed files with 122 additions and 115 deletions

View File

@@ -373,7 +373,7 @@ type HistogramStatistics struct {
}
type HistogramRecord struct {
Time int64 `json:"time" description:"time point"`
Time int64 `json:"time" description:"timestamp"`
Count int64 `json:"count" description:"total number of logs at intervals"`
}
@@ -393,7 +393,7 @@ type HistogramResult struct {
// Wrap elasticsearch response
type QueryResult struct {
Status int `json:"status,omitempty" description:"query status"`
Error string `json:"error,omitempty" description:"debug information"`
Error string `json:"error,omitempty" description:"debugging information"`
Workspace string `json:"workspace,omitempty" description:"workspace the query was performed against"`
Read *ReadResult `json:"query,omitempty" description:"query results"`
Statistics *StatisticsResult `json:"statistics,omitempty" description:"statistics results"`