Added IRIs as extra field properties in datamodels

oteapi/models/datacacheconfig.py

@@ -10,13 +10,15 @@
 
 class DataCacheConfig(AttrDict):
     """DataCache Configuration.
-
     This class should not be used directly as a configuration object
     for a strategy object, but only as a configuration field inside
     a configuration object.
     """
 
-    cacheDir: Path = Field(Path("oteapi"), description="Cache directory.")
+    cacheDir: Path = Field(
+        Path("oteapi"),
+        description="Cache directory.",
+    )
     accessKey: Optional[str] = Field(
         None,
         description="Key with which the downloaded content can be accessed. "
@@ -36,6 +38,5 @@ class DataCacheConfig(AttrDict):
     tag: Optional[str] = Field(
         None,
         description="Tag assigned to the downloaded content, typically "
-        "identifying a session. Used with the `evict()` method to clean up a "
-        "all cache entries with a given tag.",
+        "identifying a session. Used with the `evict()` method to clean up all cache entries with a given tag.",
     )

oteapi/models/filterconfig.py

@@ -11,13 +11,22 @@ class FilterConfig(GenericConfig):
     """Filter Strategy Data Configuration."""
 
     filterType: str = Field(
-        ..., description="Type of registered filter strategy. E.g., `filter/sql`."
+        ...,
+        description="Type of registered filter strategy. E.g., `filter/sql`.",
+        IRI="http://purl.org/dc/terms/type",  # type: ignore
+    )
+    query: Optional[str] = Field(
+        None,
+        description="Define a query operation.",
+        IRI="http://www.w3.org/1999/02/22-rdf-syntax-ns#Statement",  # type: ignore
     )
-    query: Optional[str] = Field(None, description="Define a query operation.")
     condition: Optional[str] = Field(
         None,
         description="Logical statement indicating when a filter should be applied.",
+        IRI="http://www.w3.org/2000/01/rdf-schema#comment",  # type: ignore
     )
     limit: Optional[int] = Field(
-        None, description="Number of items remaining after a filter expression."
+        None,
+        description="Number of items remaining after a filter expression.",
+        IRI="http://schema.org/Integer",  # type: ignore
     )

oteapi/models/mappingconfig.py

@@ -15,15 +15,18 @@ class MappingConfig(GenericConfig):
     mappingType: str = Field(
         ...,
         description="Type of registered mapping strategy.",
+        IRI="http://purl.org/dc/terms/type",  # type: ignore
     )
     prefixes: Optional[Dict[str, str]] = Field(
         None,
         description=(
             "Dictionary of shortnames that expands to an IRI given as local "
             "value/IRI-expansion-pairs."
         ),
+        IRI="http://www.w3.org/2004/02/skos/core#notation",  # type: ignore
     )
     triples: Optional[Set[RDFTriple]] = Field(
         None,
         description="Set of RDF triples given as (subject, predicate, object).",
+        IRI="http://www.w3.org/1999/02/22-rdf-syntax-ns#Statement",  # type: ignore
     )

oteapi/models/parserconfig.py

@@ -8,5 +8,13 @@
 class ParserConfig(GenericConfig):
     """Parser Strategy Data Configuration."""
 
-    parserType: str = Field(..., description="Type of registered parser strategy.")
-    entity: AnyHttpUrl = Field(..., description="IRI to the entity or collection.")
+    parserType: str = Field(
+        ...,
+        description="Type of registered parser strategy.",
+        IRI="http://purl.org/dc/terms/type",
+    )  # type: ignore
+    entity: AnyHttpUrl = Field(
+        ...,
+        description="IRI to the metadata (entity) or collection of entities.",
+        IRI="http://schema.org/URL",
+    )  # type: ignore

oteapi/models/resourceconfig.py

@@ -21,7 +21,9 @@ class ResourceConfig(GenericConfig, SecretConfig):
     """
 
     resourceType: Optional[str] = Field(
-        None, description="Type of registered resource strategy."
+        None,
+        description="Type of registered resource strategy.",
+        IRI="http://purl.org/dc/terms/type",  # type: ignore
     )
 
     downloadUrl: Optional[HostlessAnyUrl] = Field(
@@ -32,6 +34,7 @@ class ResourceConfig(GenericConfig, SecretConfig):
             " which this distribution is available directly, typically through a HTTPS"
             " GET request or SFTP."
         ),
+        IRI="http://www.w3.org/ns/dcat#downloadURL",  # type: ignore
     )
     mediaType: Optional[str] = Field(
         None,
@@ -42,6 +45,7 @@ class ResourceConfig(GenericConfig, SecretConfig):
             " type of the distribution is defined in IANA "
             "[[IANA-MEDIA-TYPES](https://www.w3.org/TR/vocab-dcat-2/#bib-iana-media-types)]."
         ),
+        IRI="http://www.w3.org/ns/dcat#mediaType",  # type: ignore
     )
     accessUrl: Optional[HostlessAnyUrl] = Field(
         None,
@@ -53,28 +57,33 @@ class ResourceConfig(GenericConfig, SecretConfig):
             "query or API call.\n`downloadURL` is preferred for direct links to "
             "downloadable resources."
         ),
+        IRI="http://www.w3.org/ns/dcat#accessURL",  # type: ignore
     )
     accessService: Optional[str] = Field(
         None,
         description=(
             "A data service that gives access to the distribution of the dataset."
         ),
+        IRI="http://www.w3.org/ns/dcat#accessService",  # type: ignore
     )
     license: Optional[str] = Field(
         None,
         description=(
             "A legal document under which the distribution is made available."
         ),
+        IRI="http://purl.org/dc/terms/license",  # type: ignore
     )
     accessRights: Optional[str] = Field(
         None,
         description=(
             "A rights statement that concerns how the distribution is accessed."
         ),
+        IRI="http://purl.org/dc/terms/accessRights",  # type: ignore
     )
     publisher: Optional[str] = Field(
         None,
         description="The entity responsible for making the resource/item available.",
+        IRI="http://purl.org/dc/terms/publisher",  # type: ignore
     )
 
     @model_validator(mode="after")

oteapi/models/secretconfig.py

@@ -23,20 +23,22 @@ class SecretConfig(BaseModel):
     """Simple model for handling secret in other config-models."""
 
     user: Optional[TogglableSecretStr] = Field(
-        None, description="User name for authentication."
+        None,
+        description="User name for authentication.",
     )
     password: Optional[TogglableSecretStr] = Field(
-        None, description="Password for authentication."
+        None,
+        description="Password for authentication.",
     )
     token: Optional[TogglableSecretStr] = Field(
         None,
-        description=(
-            "An access token for providing access and meta data to an application."
-        ),
+        description="An access token for providing access and meta data to an application.",
     )
     client_id: Optional[TogglableSecretStr] = Field(
-        None, description="Client ID for an OAUTH2 client."
+        None,
+        description="Client ID for an OAUTH2 client.",
     )
     client_secret: Optional[TogglableSecretStr] = Field(
-        None, description="Client secret for an OAUTH2 client."
+        None,
+        description="Client secret for an OAUTH2 client.",
     )

oteapi/models/transformationconfig.py

@@ -39,40 +39,58 @@ class TransformationConfig(GenericConfig, SecretConfig):
         description=(
             "Type of registered transformation strategy. E.g., `celery/remote`."
         ),
+        IRI="http://purl.org/dc/terms/type",  # type: ignore
     )
     name: Optional[str] = Field(
-        None, description="Human-readable name of the transformation strategy."
+        None,
+        description="Human-readable name of the transformation strategy.",
+        IRI="http://purl.org/dc/elements/1.1/title",  # type: ignore
     )
     due: Optional[datetime] = Field(
         None,
         description=(
             "Optional field to indicate a due data/time for when a transformation "
             "should finish."
         ),
+        IRI="http://purl.org/dc/terms/date",  # type: ignore
     )
     priority: Optional[ProcessPriority] = Field(
         ProcessPriority.MEDIUM,
         description="Define the process priority of the transformation execution.",
+        IRI="http://www.w3.org/ns/adms#status",  # type: ignore
     )
 
 
 class TransformationStatus(BaseModel):
     """Return from transformation status."""
 
-    id: str = Field(..., description="ID for the given transformation process.")
+    id: str = Field(
+        ...,
+        description="ID for the given transformation process.",
+        IRI="http://purl.org/dc/terms/identifier",  # type: ignore
+    )
     status: Optional[str] = Field(
-        None, description="Status for the transformation process."
+        None,
+        description="Status for the transformation process.",
+        IRI="http://www.w3.org/ns/adms#status",  # type: ignore
     )
     messages: Optional[List[str]] = Field(
-        None, description="Messages related to the transformation process."
+        None,
+        description="Messages related to the transformation process.",
+        IRI="http://purl.org/dc/terms/description",  # type: ignore
     )
     created: Optional[datetime] = Field(
         None,
         description="Time of creation for the transformation process. Given in UTC.",
+        IRI="http://purl.org/dc/terms/created",  # type: ignore
     )
     startTime: Optional[datetime] = Field(
-        None, description="Time when the transformation process started. Given in UTC."
+        None,
+        description="Time when the transformation process started. Given in UTC.",
+        IRI="http://purl.org/dc/terms/date",  # type: ignore
     )
     finishTime: Optional[datetime] = Field(
-        None, description="Time when the tranformation process finished. Given in UTC."
+        None,
+        description="Time when the tranformation process finished. Given in UTC.",
+        IRI="http://purl.org/dc/terms/date",  # type: ignore
     )

oteapi/strategies/parse/application_json.py

@@ -45,6 +45,7 @@ class JSONParserConfig(ParserConfig):
         "parser/json",
         description=ParserConfig.model_fields["parserType"].description,
     )
+
     configuration: JSONConfig = Field(
         ..., description="JSON parse strategy-specific configuration."
     )