gh-1106 extend get single thing with api links

weaviate · Mar 26, 2020 · 90bad8b · 90bad8b
1 parent 1aefdd0
commit 90bad8b
Show file tree

Hide file tree

Showing 7 changed files with 119 additions and 1 deletion.
diff --git a/adapters/handlers/rest/embedded_spec.go b/adapters/handlers/rest/embedded_spec.go
diff --git a/adapters/handlers/rest/handlers_kinds.go b/adapters/handlers/rest/handlers_kinds.go
@@ -15,13 +15,15 @@ package rest
 
 import (
 	"context"
+	"fmt"
 
 	middleware "github.com/go-openapi/runtime/middleware"
 	"github.com/go-openapi/strfmt"
 	"github.com/semi-technologies/weaviate/adapters/handlers/rest/operations"
 	"github.com/semi-technologies/weaviate/adapters/handlers/rest/operations/actions"
 	"github.com/semi-technologies/weaviate/adapters/handlers/rest/operations/things"
 	"github.com/semi-technologies/weaviate/entities/models"
+	"github.com/semi-technologies/weaviate/entities/schema/crossref"
 	"github.com/semi-technologies/weaviate/usecases/auth/authorization/errors"
 	"github.com/semi-technologies/weaviate/usecases/kinds"
 	"github.com/semi-technologies/weaviate/usecases/telemetry"
@@ -161,6 +163,11 @@ func (h *kindHandlers) getThing(params things.ThingsGetParams,
 		}
 	}
 
+	schemaMap, ok := thing.Schema.(map[string]interface{})
+	if ok {
+		thing.Schema = h.extendSchemaWithAPILinks(schemaMap)
+	}
+
 	h.telemetryLogAsync(telemetry.TypeREST, telemetry.LocalQuery)
 	return things.NewThingsGetOK().WithPayload(thing)
 }
@@ -540,3 +547,39 @@ func derefBool(in *bool) bool {
 
 	return *in
 }
+
+func (h *kindHandlers) extendSchemaWithAPILinks(schema map[string]interface{}) map[string]interface{} {
+	if schema == nil {
+		return schema
+	}
+
+	for key, value := range schema {
+		asMultiRef, ok := value.(models.MultipleRef)
+		if !ok {
+			continue
+		}
+
+		schema[key] = h.extendReferencesWithAPILinks(asMultiRef)
+	}
+	return schema
+}
+
+func (h *kindHandlers) extendReferencesWithAPILinks(refs models.MultipleRef) models.MultipleRef {
+	for i, ref := range refs {
+		refs[i] = h.extendReferenceWithAPILink(ref)
+	}
+
+	return refs
+}
+
+func (h *kindHandlers) extendReferenceWithAPILink(ref *models.SingleRef) *models.SingleRef {
+
+	parsed, err := crossref.Parse(ref.Beacon.String())
+	if err != nil {
+		// ignore return unchanged
+		return ref
+	}
+
+	ref.Href = strfmt.URI(fmt.Sprintf("%s/v1/%ss/%s", "", parsed.Kind.Name(), parsed.TargetID))
+	return ref
+}
diff --git a/adapters/handlers/rest/handlers_kinds_test.go b/adapters/handlers/rest/handlers_kinds_test.go
@@ -27,6 +27,39 @@ func TestEnrichObjectsWithLinks(t *testing.T) {
 				thing:          &models.Thing{Class: "Foo", Schema: nil},
 				expectedResult: &models.Thing{Class: "Foo", Schema: nil},
 			},
+			test{
+				name: "without ref props - nothing changes",
+				thing: &models.Thing{Class: "Foo", Schema: map[string]interface{}{
+					"name":           "hello world",
+					"numericalField": 134,
+				}},
+				expectedResult: &models.Thing{Class: "Foo", Schema: map[string]interface{}{
+					"name":           "hello world",
+					"numericalField": 134,
+				}},
+			},
+			test{
+				name: "with a ref prop - no origin configured",
+				thing: &models.Thing{Class: "Foo", Schema: map[string]interface{}{
+					"name":           "hello world",
+					"numericalField": 134,
+					"someRef": models.MultipleRef{
+						&models.SingleRef{
+							Beacon: "weaviate://localhost/things/85f78e29-5937-4390-a121-5379f262b4e5",
+						},
+					},
+				}},
+				expectedResult: &models.Thing{Class: "Foo", Schema: map[string]interface{}{
+					"name":           "hello world",
+					"numericalField": 134,
+					"someRef": models.MultipleRef{
+						&models.SingleRef{
+							Beacon: "weaviate://localhost/things/85f78e29-5937-4390-a121-5379f262b4e5",
+							Href:   "/v1/things/85f78e29-5937-4390-a121-5379f262b4e5",
+						},
+					},
+				}},
+			},
 		}
 
 		for _, test := range tests {

diff --git a/entities/models/single_ref.go b/entities/models/single_ref.go
diff --git a/openapi-specs/schema.json b/openapi-specs/schema.json
@@ -606,6 +606,11 @@
           "format": "uri",
           "type": "string"
         },
+        "href": {
+          "description": "If using a direct reference, this read-only fields provides a link to the refernced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.",
+          "format": "uri",
+          "type": "string"
+        },
         "meta": {
           "description": "Additional Meta information about this particular reference. Only shown if meta==true.",
           "$ref": "#/definitions/ReferenceMeta"

diff --git a/test/acceptance/things/crefs_cardinality_many_test.go b/test/acceptance/things/crefs_cardinality_many_test.go
@@ -118,6 +118,7 @@ func Test_CREFWithCardinalityMany_UsingPatch(t *testing.T) {
 		"hasPlaces": []interface{}{
 			map[string]interface{}{
 				"beacon": fmt.Sprintf("weaviate://localhost/things/%s", place1ID.String()),
+				"href":   fmt.Sprintf("/v1/things/%s", place1ID.String()),
 			},
 		},
 	}, actualThunk)
@@ -147,9 +148,11 @@ func Test_CREFWithCardinalityMany_UsingPatch(t *testing.T) {
 	expectedRefs := []interface{}{
 		map[string]interface{}{
 			"beacon": fmt.Sprintf("weaviate://localhost/things/%s", place1ID.String()),
+			"href":   fmt.Sprintf("/v1/things/%s", place1ID.String()),
 		},
 		map[string]interface{}{
 			"beacon": fmt.Sprintf("weaviate://localhost/things/%s", place2ID.String()),
+			"href":   fmt.Sprintf("/v1/things/%s", place2ID.String()),
 		},
 	}
 
@@ -243,6 +246,7 @@ func Test_CREFWithCardinalityMany_UsingPostReference(t *testing.T) {
 		"hasPlaces": []interface{}{
 			map[string]interface{}{
 				"beacon": fmt.Sprintf("weaviate://localhost/things/%s", place1ID.String()),
+				"href":   fmt.Sprintf("/v1/things/%s", place1ID.String()),
 			},
 		},
 	}, actualThunk)
@@ -266,9 +270,11 @@ func Test_CREFWithCardinalityMany_UsingPostReference(t *testing.T) {
 	expectedRefs := []interface{}{
 		map[string]interface{}{
 			"beacon": fmt.Sprintf("weaviate://localhost/things/%s", place1ID.String()),
+			"href":   fmt.Sprintf("/v1/things/%s", place1ID.String()),
 		},
 		map[string]interface{}{
 			"beacon": fmt.Sprintf("weaviate://localhost/things/%s", place2ID.String()),
+			"href":   fmt.Sprintf("/v1/things/%s", place2ID.String()),
 		},
 	}
 

diff --git a/test/acceptance/things/crefs_without_waiting_for_refresh_test.go b/test/acceptance/things/crefs_without_waiting_for_refresh_test.go
@@ -96,8 +96,8 @@ func Test_AddingReferenceWithoutWaiting_UsingPostThings(t *testing.T) {
 		"hasPlace": []interface{}{
 			map[string]interface{}{
 				"beacon": fmt.Sprintf("weaviate://localhost/things/%s", placeID.String()),
+				"href":   fmt.Sprintf("/v1/things/%s", placeID.String()),
 			},
 		},
 	}, actualThunk)
-
 }