Enabling @context in metadata and metadata definition (#750)

* Enabling @context in metadata and metadata definition

* adding test

* adding codegen files

* removing redundant code block

* Fixed typo.

---------

Co-authored-by: Luigi Marini <[email protected]>

Author: ddey2

backend/app/models/metadata.py

@@ -2,7 +2,7 @@
 from datetime import datetime
 from typing import Optional, List, Union
 
-from beanie import Document, PydanticObjectId
+from beanie import Document
 from elasticsearch import Elasticsearch, NotFoundError
 from fastapi import HTTPException
 from pydantic import Field, validator, AnyUrl, BaseModel
@@ -11,7 +11,6 @@
     EventListenerIn,
     LegacyEventListenerIn,
     EventListenerOut,
-    ExtractorInfo,
 )
 from app.models.mongomodel import MongoDBRef
 from app.models.users import UserOut
@@ -101,6 +100,14 @@ class MetadataDefinitionBase(BaseModel):
     class Settings:
         name = "metadata_definitions"
 
+    class Config:
+        # Serialization Config Options
+        # Specify JSON key names
+        # This will rename the field `context` to `@context` in the JSON output
+        fields = {"context": {"alias": "@context"}}
+        # This will allow input by field name 'context' too along with '@context'
+        allow_population_by_field_name = True
+
 
 class MetadataDefinitionIn(MetadataDefinitionBase):
     pass
@@ -184,6 +191,14 @@ class MetadataBase(BaseModel):
         str
     ]  # This will be fetched from metadata definition if one is provided (shown by GUI)
 
+    class Config:
+        # Serialization Config Options
+        # Specify JSON key names
+        # This will rename the field `context` to `@context` in the JSON output
+        fields = {"context": {"alias": "@context"}}
+        # This will allow input by field name 'context' too along with '@context'
+        allow_population_by_field_name = True
+
     @validator("context")
     def contexts_are_valid(cls, v):
         if False:

backend/app/tests/test_metadata.py

@@ -10,7 +10,7 @@
 metadata_definition = {
     "name": "LatLon",
     "description": "A set of Latitude/Longitude coordinates",
-    "context": [
+    "@context": [
         {
             "longitude": "https://schema.org/longitude",
             "latitude": "https://schema.org/latitude",
@@ -37,7 +37,7 @@
 metadata_definition2 = {
     "name": "AlternativeTitle",
     "description": "Alternative title",
-    "context": [{"title": "https://schema.org/alternateName"}],
+    "@context": [{"title": "https://schema.org/alternateName"}],
     "fields": [
         {
             "name": "alternateName",
@@ -85,6 +85,9 @@ def test_dataset_create_metadata_definition(client: TestClient, headers: dict):
         response.status_code == 200 or response.status_code == 409
     )  # 409 = definition already exists
 
+    # check if @context is injected correctly
+    assert response.json().get("@context") is not None
+
     # Create dataset and add metadata to it using new definition
     dataset_id = create_dataset(client, headers).get("id")
     response = client.post(

frontend/src/openapi/v2/models/MetadataDefinitionIn.ts

@@ -42,7 +42,7 @@ import type { MetadataField } from './MetadataField';
                                 export type MetadataDefinitionIn = {
                                     name: string;
                                     description?: string;
-                                    context?: Array<string>;
+                                    '@context'?: Array<string>;
                                     context_url?: string;
                                     fields: Array<MetadataField>;
                                 }

frontend/src/openapi/v2/models/MetadataDefinitionOut.ts

@@ -21,7 +21,7 @@ import type { UserOut } from './UserOut';
 export type MetadataDefinitionOut = {
     name: string;
     description?: string;
-    context?: Array<string>;
+    '@context'?: Array<string>;
     context_url?: string;
     fields: Array<MetadataField>;
     _id?: string;

frontend/src/openapi/v2/models/MetadataIn.ts

@@ -6,7 +6,7 @@ import type { EventListenerIn } from './EventListenerIn';
 import type { LegacyEventListenerIn } from './LegacyEventListenerIn';
 
 export type MetadataIn = {
-    context?: Array<string>;
+    '@context'?: Array<string>;
     context_url?: string;
     definition?: string;
     content: any;

frontend/src/openapi/v2/models/MetadataOut.ts

@@ -19,7 +19,7 @@ import type { MongoDBRef } from './MongoDBRef';
  * - [UpdateMethods](https://roman-right.github.io/beanie/api/interfaces/#aggregatemethods)
  */
 export type MetadataOut = {
-    context?: Array<string>;
+    '@context'?: Array<string>;
     context_url?: string;
     definition?: string;
     content: any;

frontend/src/openapi/v2/models/MetadataPatch.ts

@@ -6,7 +6,7 @@ import type { EventListenerIn } from './EventListenerIn';
 import type { LegacyEventListenerIn } from './LegacyEventListenerIn';
 
 export type MetadataPatch = {
-    context?: Array<string>;
+    '@context'?: Array<string>;
     context_url?: string;
     definition?: string;
     content: any;