feat(server): add JSON export for schema

server/e2e/integration_schema_export_test.go

@@ -0,0 +1,219 @@
+package e2e
+
+import (
+	"net/http"
+	"testing"
+
+	"github.com/reearth/reearth-cms/server/internal/app"
+	"github.com/reearth/reearth-cms/server/pkg/id"
+)
+
+func TestIntegrationSchemaJSONExportAPI(t *testing.T) {
+	e := StartServer(t, &app.Config{}, true, baseSeeder)
+
+	// /api/schemata/{schemaId}/schema.json
+	e.GET("/api/schemata/{schemaId}/schema.json", sid1).
+		WithHeader("authorization", "Bearer abcd").
+		Expect().
+		Status(http.StatusUnauthorized)
+
+	e.GET("/api/schemata/{schemaId}/schema.json", id.NewSchemaID()).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusNotFound)
+
+	e.GET("/api/schemata/{schemaId}/schema.json", sid1).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusOK).
+		JSON().
+		IsEqual(map[string]any{
+			"$id":     sid1,
+			"$schema": "https://json-schema.org/draft/2020-12/schema",
+			"properties": map[string]any{
+				"asset": map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+					"format":      "binary",
+				},
+				sfKey1.String(): map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+				},
+			},
+			"type": "object",
+		})
+
+	// /api/projects/{projectIdOrKey}/schemata/{schemaId}/schema.json
+	e.GET("/api/projects/{projectIdOrKey}/schemata/{schemaId}/schema.json", pid, sid1).
+		WithHeader("authorization", "Bearer abcd").
+		Expect().
+		Status(http.StatusUnauthorized)
+
+	e.GET("/api/projects/{projectIdOrKey}/schemata/{schemaId}/schema.json", pid, id.NewSchemaID()).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusNotFound)
+
+	e.GET("/api/projects/{projectIdOrKey}/schemata/{schemaId}/schema.json", pid, sid1).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusOK).
+		JSON().
+		IsEqual(map[string]any{
+			"$id":     sid1,
+			"$schema": "https://json-schema.org/draft/2020-12/schema",
+			"properties": map[string]any{
+				"asset": map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+					"format":      "binary",
+				},
+				sfKey1.String(): map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+				},
+			},
+			"type": "object",
+		})
+
+	// /api/projects/{projectIdOrKey}/models/{modelId}/schema.json
+	e.GET("/api/projects/{projectIdOrKey}/models/{modelId}/schema.json", pid, mId1).
+		WithHeader("authorization", "Bearer abcd").
+		Expect().
+		Status(http.StatusUnauthorized)
+
+	e.GET("/api/projects/{projectIdOrKey}/models/{modelId}/schema.json", pid, id.NewModelID()).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusNotFound)
+
+	e.GET("/api/projects/{projectIdOrKey}/models/{modelId}/schema.json", pid, mId1).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusOK).
+		JSON().
+		IsEqual(map[string]any{
+			"$id":     mId1,
+			"$schema": "https://json-schema.org/draft/2020-12/schema",
+			"properties": map[string]any{
+				"asset": map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+					"format":      "binary",
+				},
+				sfKey1.String(): map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+				},
+			},
+			"type":        "object",
+			"description": "m1 desc",
+			"title":       "m1",
+		})
+
+	// /api/projects/{projectIdOrKey}/models/{modelId}/metadata_schema.json
+	e.GET("/api/projects/{projectIdOrKey}/models/{modelId}/metadata_schema.json", pid, mId1).
+		WithHeader("authorization", "Bearer abcd").
+		Expect().
+		Status(http.StatusUnauthorized)
+
+	e.GET("/api/projects/{projectIdOrKey}/models/{modelId}/metadata_schema.json", pid, id.NewModelID()).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusNotFound)
+
+	e.GET("/api/projects/{projectIdOrKey}/models/{modelId}/metadata_schema.json", pid, mId1).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusOK).
+		JSON().
+		IsEqual(map[string]any{
+			"$id":     mId1,
+			"$schema": "https://json-schema.org/draft/2020-12/schema",
+			"properties": map[string]any{
+				sfKey4.String(): map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "boolean",
+				},
+			},
+			"type":        "object",
+			"description": "m1 desc",
+			"title":       "m1",
+		})
+
+	// /api/models/{modelId}/schema.json
+	e.GET("/api/models/{modelId}/schema.json", mId1).
+		WithHeader("authorization", "Bearer abcd").
+		Expect().
+		Status(http.StatusUnauthorized)
+
+	e.GET("/api/models/{modelId}/schema.json", id.NewModelID()).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusNotFound)
+
+	e.GET("/api/models/{modelId}/schema.json", mId1).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusOK).
+		JSON().
+		IsEqual(map[string]any{
+			"$id":     mId1,
+			"$schema": "https://json-schema.org/draft/2020-12/schema",
+			"properties": map[string]any{
+				"asset": map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+					"format":      "binary",
+				},
+				sfKey1.String(): map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "string",
+				},
+			},
+			"type":        "object",
+			"description": "m1 desc",
+			"title":       "m1",
+		})
+
+	// /api/models/{modelId}/metadata_schema.json
+	e.GET("/api/models/{modelId}/metadata_schema.json", mId1).
+		WithHeader("authorization", "Bearer abcd").
+		Expect().
+		Status(http.StatusUnauthorized)
+
+	e.GET("/api/models/{modelId}/metadata_schema.json", id.NewModelID()).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusNotFound)
+
+	e.GET("/api/models/{modelId}/metadata_schema.json", mId1).
+		WithHeader("authorization", "Bearer "+secret).
+		Expect().
+		Status(http.StatusOK).
+		JSON().
+		IsEqual(map[string]any{
+			"$id":     mId1,
+			"$schema": "https://json-schema.org/draft/2020-12/schema",
+			"properties": map[string]any{
+				sfKey4.String(): map[string]any{
+					"description": "",
+					"title":       "",
+					"type":        "boolean",
+				},
+			},
+			"type":        "object",
+			"description": "m1 desc",
+			"title":       "m1",
+		})
+}

server/e2e/publicapi_test.go

@@ -355,6 +355,57 @@ func TestPublicAPI(t *testing.T) {
 			// publicAPIField2Key should be removed
 		})
 
+	// schema export json
+	e.GET("/api/p/{project}/{model}/schema.json", publicAPIProjectAlias, id.RandomKey()).
+		Expect().
+		Status(http.StatusNotFound)
+
+	e.GET("/api/p/{project}/{model}/schema.json", publicAPIProjectAlias, publicAPIModelKey).
+		Expect().
+		Status(http.StatusOK).
+		JSON().
+		IsEqual(map[string]any{
+			"description": "",
+			"id":          publicAPIModelID,
+			"properties": map[string]any{
+				"asset": map[string]any{
+					"description": "",
+					"title":       "asset",
+					"type":        "string",
+					"format":      "binary",
+				},
+				"asset2": map[string]any{
+					"description": "",
+					"title":       "asset2",
+					"type":        "string",
+					"format":      "binary",
+				},
+				"geometry-editor": map[string]any{
+					"description": "",
+					"title":       "geometry-editor",
+					"type":        "object",
+				},
+				"geometry-object": map[string]any{
+					"description": "",
+					"title":       "geometry-object",
+					"type":        "object",
+				},
+				"test-field-1": map[string]any{
+					"description": "",
+					"title":       "test-field-1",
+					"type":        "string",
+				},
+				"test-field-2": map[string]any{
+					"description": "",
+					"title":       "test-field-2",
+					"type":        "string",
+				},
+			},
+			"schema": "https://json-schema.org/draft/2020-12/schema",
+			"title":  "",
+			"type":   "object",
+		})
+
 	// make the project private
 	prj.Publication().SetScope(project.PublicationScopePrivate)
 	lo.Must0(repos.Project.Save(ctx, prj))