Browse Source

Address review comments

SamuelToh 6 years ago
parent
commit
4de9e3598b
3 changed files with 8 additions and 8 deletions
  1. 2 2
      docs/sources/http_api/annotations.md
  2. 1 1
      pkg/api/annotations.go
  3. 5 5
      pkg/api/dtos/annotations.go

+ 2 - 2
docs/sources/http_api/annotations.md

@@ -189,6 +189,8 @@ Content-Type: application/json
 
 Updates one or more properties of an annotation that matches the specified id.
 
+The `PATCH` operation currently supports updating of the `text`, `tags`, `time` and `timeEnd` properties. It does not handle updating of the `isRegion` and `regionId` properties. To make an annotation regional or vice versa, consider using the `PUT` operation.
+
 **Example Request**:
 
 ```json
@@ -198,8 +200,6 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
 Content-Type: application/json
 
 {
-  "time":1507037197000,
-  "timeEnd":1507180807095,
   "text":"New Annotation Description",
   "tags":["tag6","tag7","tag8"]
 }

+ 1 - 1
pkg/api/annotations.go

@@ -222,7 +222,7 @@ func PatchAnnotation(c *m.ReqContext, cmd dtos.PatchAnnotationsCmd) Response {
 	items, err := repo.Find(&annotations.ItemQuery{AnnotationId: annotationID, OrgId: c.OrgId})
 
 	if err != nil || len(items) == 0 {
-		return Error(500, "Could not find annotation to update", err)
+		return Error(404, "Could not find annotation to update", err)
 	}
 
 	existing := annotations.Item{

+ 5 - 5
pkg/api/dtos/annotations.go

@@ -23,11 +23,11 @@ type UpdateAnnotationsCmd struct {
 }
 
 type PatchAnnotationsCmd struct {
-	Id       int64    `json:"id"`
-	Time     int64    `json:"time"`
-	Text     string   `json:"text"`
-	Tags     []string `json:"tags"`
-	TimeEnd  int64    `json:"timeEnd"`
+	Id      int64    `json:"id"`
+	Time    int64    `json:"time"`
+	Text    string   `json:"text"`
+	Tags    []string `json:"tags"`
+	TimeEnd int64    `json:"timeEnd"`
 }
 
 type DeleteAnnotationsCmd struct {