Project

General

Profile

Feature #1551

API: Relation type adaptions, adding relationDescription

Added by Bernhard Koschiček-Krombholz 3 months ago. Updated about 1 month ago.

Status:
Closed
Priority:
Low
Category:
API
Target version:
Start date:
2021-07-27
Estimated time:

Description

  • relation type stayed the same, but the value is now camel case and therefore valid as n3.
  • Added a new field named relationDescription for the descriptions of links (mostly page numbers).

In the relation object, we added type for external reference systems for the match of the relation. If the relation is not a reference system, type has the value null, which is not allowed in json-ld and therefore in rdf. We should rename it to a fitting key name. I don't know if Link.type contains other things than reference systems matches, but if not, the name "match" would fit.
So name is open for discussion, but we have to change it.

"relations":[
   {
      "label":"Monastery",
      "relationTo":"http://127.0.0.1:5000/api/0.2/entity/283",
      "relationType":"crm:P2 has type",
      "relationSystemClass":"type",
      "type":null,
      "when":{
         "timespans":[
            {
               "start":{
                  "earliest":"None",
                  "latest":"None" 
               },
               "end":{
                  "earliest":"None",
                  "latest":"None" 
               }
            }
         ]
      }
   },
   {
      "label":"GeoNames",
      "relationTo":"http://127.0.0.1:5000/api/0.2/entity/123747",
      "relationType":"crm:P67i is referred to by",
      "relationSystemClass":"reference_system",
      "type":"close match",
      "when":{
         "timespans":[
            {
               "start":{
                  "earliest":"None",
                  "latest":"None" 
               },
               "end":{
                  "earliest":"None",
                  "latest":"None" 
               }
            }
         ]
      }
   }
]


Related issues

Blocks Feature #1184: API: add additional output format RDFSClosed2020-03-27Actions

History

#1

Updated by Bernhard Koschiček-Krombholz 3 months ago

  • Blocks Feature #1184: API: add additional output format RDFS added
#2

Updated by Bernhard Koschiček-Krombholz 3 months ago

rename to relationType

#3

Updated by Bernhard Koschiček-Krombholz 3 months ago

relationType is already in use and a LPO namespace. I would suggest relationDescription. If no one vote against it, I will implement it with the RDF feature.

#4

Updated by Alexander Watzinger 3 months ago

Why do they have to use so many of our names ;)
Seriously, relationDescription might not be a good idea because our relations can have a description too, e.g. reference links may have page information in it.
I'm not very creative right now but what about linkType or relationCategory?

#5

Updated by Bernhard Koschiček-Krombholz about 2 months ago

Ok, I found out, that the n3 format has no problem with type, but with exact match. If it is correctly written, exactMatch, it is no problem and will be integrated in the results.

So type will remain, but the result will be shown in the correct form.

#6

Updated by Bernhard Koschiček-Krombholz about 2 months ago

  • Status changed from New to Resolved
  • Description updated (diff)
#7

Updated by Bernhard Koschiček-Krombholz about 2 months ago

  • Subject changed from API: type in relations are not json-ld conform to API: Relation type refactored and adding of relationDescription
#8

Updated by Bernhard Koschiček-Krombholz about 2 months ago

  • Target version changed from API to 6.5.0
  • Status changed from Resolved to Closed
#9

Updated by Alexander Watzinger about 1 month ago

  • Subject changed from API: Relation type refactored and adding of relationDescription to API: Relation type adaptions, adding relationDescription

Also available in: Atom PDF