Return evidence after successful create. (#263)

* Return evidence after successful create.

* Update swag

Author: Chris Vermeulen

docs/docs.go

@@ -259,7 +259,10 @@ const docTemplate = `{
                 ],
                 "responses": {
                     "201": {
-                        "description": "Created"
+                        "description": "Created",
+                        "schema": {
+                            "$ref": "#/definitions/handler.GenericDataResponse-relational_Evidence"
+                        }
                     },
                     "400": {
                         "description": "Bad Request",
@@ -16691,6 +16694,19 @@ const docTemplate = `{
                 }
             }
         },
+        "handler.GenericDataResponse-relational_Evidence": {
+            "type": "object",
+            "properties": {
+                "data": {
+                    "description": "Items from the list response",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/relational.Evidence"
+                        }
+                    ]
+                }
+            }
+        },
         "handler.GenericDataResponse-relational_Filter": {
             "type": "object",
             "properties": {
@@ -16741,7 +16757,7 @@ const docTemplate = `{
                         "$ref": "#/definitions/oscalTypes_1_1_3.Activity"
                     }
                 },
-                "backMatter": {
+                "back-matter": {
                     "$ref": "#/definitions/relational.BackMatter"
                 },
                 "components": {
@@ -21948,7 +21964,7 @@ const docTemplate = `{
                         "$ref": "#/definitions/relational.Activity"
                     }
                 },
-                "backMatter": {
+                "back-matter": {
                     "$ref": "#/definitions/relational.BackMatter"
                 },
                 "components": {

docs/swagger.json

@@ -253,7 +253,10 @@
                 ],
                 "responses": {
                     "201": {
-                        "description": "Created"
+                        "description": "Created",
+                        "schema": {
+                            "$ref": "#/definitions/handler.GenericDataResponse-relational_Evidence"
+                        }
                     },
                     "400": {
                         "description": "Bad Request",
@@ -16685,6 +16688,19 @@
                 }
             }
         },
+        "handler.GenericDataResponse-relational_Evidence": {
+            "type": "object",
+            "properties": {
+                "data": {
+                    "description": "Items from the list response",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/relational.Evidence"
+                        }
+                    ]
+                }
+            }
+        },
         "handler.GenericDataResponse-relational_Filter": {
             "type": "object",
             "properties": {
@@ -16735,7 +16751,7 @@
                         "$ref": "#/definitions/oscalTypes_1_1_3.Activity"
                     }
                 },
-                "backMatter": {
+                "back-matter": {
                     "$ref": "#/definitions/relational.BackMatter"
                 },
                 "components": {
@@ -21942,7 +21958,7 @@
                         "$ref": "#/definitions/relational.Activity"
                     }
                 },
-                "backMatter": {
+                "back-matter": {
                     "$ref": "#/definitions/relational.BackMatter"
                 },
                 "components": {

docs/swagger.yaml

@@ -1045,6 +1045,13 @@ definitions:
         - $ref: '#/definitions/oscalTypes_1_1_3.Task'
         description: Items from the list response
     type: object
+  handler.GenericDataResponse-relational_Evidence:
+    properties:
+      data:
+        allOf:
+        - $ref: '#/definitions/relational.Evidence'
+        description: Items from the list response
+    type: object
   handler.GenericDataResponse-relational_Filter:
     properties:
       data:
@@ -1075,7 +1082,7 @@ definitions:
         items:
           $ref: '#/definitions/oscalTypes_1_1_3.Activity'
         type: array
-      backMatter:
+      back-matter:
         $ref: '#/definitions/relational.BackMatter'
       components:
         items:
@@ -4506,7 +4513,7 @@ definitions:
         items:
           $ref: '#/definitions/relational.Activity'
         type: array
-      backMatter:
+      back-matter:
         $ref: '#/definitions/relational.BackMatter'
       components:
         description: Which components of the subject are being observed. A tool, user,
@@ -5622,6 +5629,8 @@ paths:
       responses:
         "201":
           description: Created
+          schema:
+            $ref: '#/definitions/handler.GenericDataResponse-relational_Evidence'
         "400":
           description: Bad Request
           schema:

internal/api/handler/evidence.go

@@ -165,7 +165,7 @@ type EvidenceCreateRequest struct {
 //	@Accept			json
 //	@Produce		json
 //	@Param			evidence	body		EvidenceCreateRequest	true	"Evidence create request"
-//	@Success		201			{object}	nil
+//	@Success		201			{object}	GenericDataResponse[relational.Evidence]
 //	@Failure		400			{object}	api.Error
 //	@Failure		500			{object}	api.Error
 //	@Security		OAuth2Password
@@ -358,7 +358,7 @@ func (h *EvidenceHandler) Create(ctx echo.Context) error {
 	}
 
 	// Return a 201 Created response with no content.
-	return ctx.NoContent(http.StatusCreated)
+	return ctx.JSON(http.StatusCreated, GenericDataResponse[relational.Evidence]{Data: evidence})
 }
 
 // Search godoc

internal/service/relational/evidence.go

@@ -19,7 +19,7 @@ type Evidence struct {
 	// UUID needs to remain consistent when automation runs again, but unique for each subject.
 	// It represents the "stream" of the same observation being made over time.
 	UUID       uuid.UUID   `gorm:"index:evidence_stream_idx;index:evidence_stream_collected_idx,priority:1" json:"uuid,omitempty"`
-	BackMatter *BackMatter `gorm:"polymorphic:Parent;"`
+	BackMatter *BackMatter `gorm:"polymorphic:Parent;" json:"back-matter,omitempty"`
 
 	Title       string  `json:"title"`
 	Description string  `json:"description"`