Expected levels of implementation for each MOD-API calls

[jonquet]

Proposition is to add a response to this discussion per participant into MOD-API implementation action. You can use a table to present the level of implementation you plan to have for each calls of the MOD-API spec.

Reminder:

• Level 0: No implementation. Will just provide a mapping between the MOD-API calls and the closest(s) portal call as well as a mapping from portal metadata properties to MOD.
• Level 1: Implement the call URLs but don’t care about what these URLs return in each formats.
• Level 2: Level 1 and the objects returned are the ones specified by MOD-API but don’t care about the properties.
• Level 3: Level 2 with as much properties as possible coming from MOD.
• Level 4: Level 3 with a minimal metadata standard respected (FAIRsFAIR).

Please copy paste the table structure bellow and use it to respond for your SAC. Then tick the following list:

• AgroPortal
• EcoPortal
• EarthPortal
• Linked Open Vocabulary (LOV)
• NERC Vocabulary Server (NVS)
• Multiple (SKOSMOS)
• Multiple (ShowVoc)
• TS4NFDIAPI Gateway
• TIB Terminology Service
• EBI Ontology Lookup Service
• VocPrez / Prez
• BioPortal
• AberOWL
• TermPortalen
• OpenTheso

[jonquet]

AgroPortal and then OntoPortal expected level of implementations:

Call	Expected level	Comments
/artefacts	Level 4
/artefacts/{artefactID}	Level 4
/artefacts/{artefactID}/distributions	Level 4
/artefacts/{artefactID}/distributions/{distributionID}	Level 4
/artefacts/{artefactID}/distributions/latest/resources	Level 0	This call need clarification #8
/artefacts/{artefactID}/record	Level 4
/artefacts/{artefactID}/resources	Level 3	No minimum metadata available in MOD for rdf:Resource
/artefacts/{artefactID}/resources/{resourceID}	Level 3	No minimum metadata available in MOD for rdf:Resource
/artefacts/{artefactID}/resources/classes	Level 3	No minimum metadata available in MOD for owl:Classes
/artefacts/{artefactID}/resources/concepts	Level 3	No minimum metadata available in MOD for skos:Concept
/artefacts/{artefactID}/resources/properties	Level 3	No minimum metadata available in MOD for rdf:Property
/artefacts/{artefactID}/resources/individuals	Level 3	No minimum metadata available in MOD for owl:NamedIndividual
/artefacts/{artefactID}/resources/schemes	Level 3	No minimum metadata available in MOD for skos:Scheme
/artefacts/{artefactID}/resources/collection	Level 3	No minimum metadata available in MOD for skos:Collection
/artefacts/{artefactID}/resources/labels	Level 3	No minimum metadata available in MOD for skos-xl:Label
/	Level 3	No minimum metadata available in MOD for mod:SemanticArtefactCatalogue
/records	Level 4
/records/{artefactID}	Level 4
/search	Level 0	Not sure yet
/search/content	Level 1	Not sure yet as we search by default only for classes/concepts
/search/metadata	Level 0	Not available in our API for the moment
/doc/api	Level 0

[jonquet]

@imadbourouche Sounds ok for us?

[imadbourouche]

@jonquet Yes sounds good with note that all these levels will be respecting the mod specifications (formats and params ..etc)

[syphax-bouazzouni]

For the API Gateway, that's the current expected level

• Metadata endpoints:
  • / Level 4
  • /doc/api Level 4
  • /artefacts Level 3
  • /artefacts/{artefactID} Level 3
• Data endpoints:
  • /artefacts/{artefactID}/resources/classes Level 3
  • /artefacts/{artefactID}/resources/concepts Level 3
  • /artefacts/{artefactID}/resources/properties Level 3
  • /artefacts/{artefactID}/resources/individuals Level 3
  • /artefacts/{artefactID}/resources/schemes Level 3
  • /artefacts/{artefactID}/resources/collection Level 3
• Search endpoints:
  • /search/content Level 3
  • /search/metadata Level 3

All other endpoints, no listed above will be probably Level 0

[alko-k]

For NVS here are our implementations so far:
https://vocab.nerc.ac.uk/artefacts/R04/distributions/ Level?
https://vocab.nerc.ac.uk/artefacts/{artefactID} e.g. https://vocab.nerc.ac.uk/artefacts/R04/ Level?
https://vocab.nerc.ac.uk/artefacts/{artefactID}/distributions/ e.g. https://vocab.nerc.ac.uk/artefacts/R04/distributions/ Level?
https://vocab.nerc.ac.uk/artefacts/{artefactID}/distributions/{distID} e.g. https://vocab.nerc.ac.uk/artefacts/R04/distributions/1 Level?

We plan to do the following but needed a bit of clarification
/
/artefacts/{artefactID}/resources/concepts

[jonquet]

@alko-k Can you write this in another entry (not a repsonse of Syphax's entry)

[djo011]

Termportalen currently aim to implement the following:

Call	Expected level	Comments
/artefacts	Level 3	Maybe level 4
/artefacts/{artefactID}	Level 3	Maybe level 4
/artefacts/{artefactID}/distributions	Level 3	Only one distribution available
/artefacts/{artefactID}/distributions/{distributionID}	Level 3	Only one distribution available
/artefacts/{artefactID}/distributions/latest/resources	Level x	Wait on clarification regarding this call
/artefacts/{artefactID}/record	Level 4
/artefacts/{artefactID}/resources	Level 3	No minimum metadata available in MOD for rdf:Resource
/artefacts/{artefactID}/resources/{resourceID}	Level 3	No minimum metadata available in MOD for rdf:Resource
/artefacts/{artefactID}/resources/classes	Level 3	No minimum metadata available in MOD for owl:Classes
/artefacts/{artefactID}/resources/concepts	Level 3	No minimum metadata available in MOD for skos:Concept
/artefacts/{artefactID}/resources/properties	Level 3	No minimum metadata available in MOD for rdf:Property
/artefacts/{artefactID}/resources/individuals	Level 3	No minimum metadata available in MOD for owl:NamedIndividual
/artefacts/{artefactID}/resources/schemes	Level 3	No minimum metadata available in MOD for skos:Scheme
/artefacts/{artefactID}/resources/collection	Level 3	No minimum metadata available in MOD for skos:Collection
/artefacts/{artefactID}/resources/labels	Level 0
/	Level 3	No minimum metadata available in MOD for mod:SemanticArtefactCatalogue
/records	Level 4
/records/{artefactID}	Level 4
/search	Level 0	Currently not a priority
/search/content	Level 0	Currently not a priority
/search/metadata	Level 0	Currently not a priority
/doc/api	Level 0	Waiting for more information about this call

[osma]

For Skosmos, here is our current plan. We are implementing a wrapper (code here) around the existing Skosmos REST API, so our implementation is limited by what the Skosmos API exposes.

Call	Expected level	Comments
/artefacts	Level 3	Corresponds to "vocabularies" in Skosmos. Only very minimal metadata available through the Skosmos API.
/artefacts/{artefactID}	Level 3	Only very minimal metadata available through the Skosmos API.
/artefacts/{artefactID}/distributions	?	Not sure what to do. Skosmos supports multiple syntaxes for vocabulary downloads (turtle, rdf/xml...) but the Skosmos API doesn't expose these directly.
/artefacts/{artefactID}/distributions/{distributionID}	?	Ditto
/artefacts/{artefactID}/distributions/latest/resources	?	We don't understand what this is. How does this relate to /artefacts/{artefactID}/resources?
/artefacts/{artefactID}/record	-	Skosmos API doesn't expose this kind of information.
/artefacts/{artefactID}/resources	Level 3	Unclear what the response should look like.
/artefacts/{artefactID}/resources/{resourceID}	Level 3	Not clear what properties should be included in the response.
/artefacts/{artefactID}/resources/classes	Level 3	Not clear what properties should be included in the response.
/artefacts/{artefactID}/resources/concepts	Level 3	Not clear what properties should be included in the response. Implementation is slow because a lot of processing has to be done in the API wrapper.
/artefacts/{artefactID}/resources/properties	Level 3	Not clear what properties should be included in the response. Implementation is slow because a lot of processing has to be done in the API wrapper.
/artefacts/{artefactID}/resources/individuals	?	We don't understand what this is.
/artefacts/{artefactID}/resources/schemes	Level 3	Not clear what properties should be included in the response.
/artefacts/{artefactID}/resources/collection	Level 3	Not clear what properties should be included in the response.
/artefacts/{artefactID}/resources/labels	Level 3	Not clear what properties should be included in the response. Implementation is slow because a lot of processing has to be done in the API wrapper.
/	-	Skosmos API doesn't have this kind of method.
/records	-	Skosmos API doesn't expose this kind of information.
/records/{artefactID}	-	Skosmos API doesn't expose this kind of information.
/search	-	Can't implement the combined search because metadata search is not available in the Skosmos API.
/search/content	Level 3	Search in Skosmos API may return both SKOS Concepts and Collections. The return format schema seems to require returning a list of only one of these at a time, but not both types in the same list.
/search/metadata	-	Not available in Skosmos API
/doc/api	-	Waiting for more information about this call

[deepananbu]

For TIB, below is our current plan

API endpoint	Expected level	Comments
/artefacts	Level 3
/artefacts/{artefactID}	Level 3
/artefacts/{artefactID}/distributions	-
/artefacts/{artefactID}/distributions/{distributionID}	-
/artefacts/{artefactID}/distributions/latest/resources	Level 3
/artefacts/{artefactID}/record	Level 3
/artefacts/{artefactID}/resources	Level 3
/artefacts/{artefactID}/resources/{resourceID}	Level 3
/artefacts/{artefactID}/resources/classes	Level 3
/artefacts/{artefactID}/resources/concepts	Level 3
/artefacts/{artefactID}/resources/properties	Level 3
/artefacts/{artefactID}/resources/individuals	Level 3
/artefacts/{artefactID}/resources/schemes	Level 3
/artefacts/{artefactID}/resources/collection	Level 3
/artefacts/{artefactID}/resources/labels	-
/	Level 3
/search	Level 3
/search/content	Level 3	Have clarification
/search/metadata	Level 3	Have clarification

[manuelfiorelli]

Expected levels for ShowVoc. I will actually revise the table as I discover that higher level can be achieved.

Call	Expected level	Comments
/artefacts	Level 3
/artefacts/{artefactID}	Level 3
/artefacts/{artefactID}/distributions	Level 3
/artefacts/{artefactID}/distributions/{distributionID}	Level 3
/artefacts/{artefactID}/distributions/latest/resources	Level 0	This call need clarification #8
/artefacts/{artefactID}/record	Level 3
/artefacts/{artefactID}/resources	Level 3	No minimum metadata available in MOD for rdf:Resource
/artefacts/{artefactID}/resources/{resourceID}	Level 3	No minimum metadata available in MOD for rdf:Resource
/artefacts/{artefactID}/resources/classes	Level 3	No minimum metadata available in MOD for owl:Classes
/artefacts/{artefactID}/resources/concepts	Level 3	No minimum metadata available in MOD for skos:Concept
/artefacts/{artefactID}/resources/properties	Level 3	No minimum metadata available in MOD for rdf:Property
/artefacts/{artefactID}/resources/individuals	Level 3	No minimum metadata available in MOD for owl:NamedIndividual
/artefacts/{artefactID}/resources/schemes	Level 3	No minimum metadata available in MOD for skos:Scheme
/artefacts/{artefactID}/resources/collection	Level 3	No minimum metadata available in MOD for skos:Collection
/artefacts/{artefactID}/resources/labels	Level 3	No minimum metadata available in MOD for skos-xl:Label
/	Level 3	No minimum metadata available in MOD for mod:SemanticArtefactCatalogue
/records	Level 3
/records/{artefactID}	Level 3
/search	Level 3	Not sure yet
/search/content	Level 3	Not sure yet as we search by default only for classes/concepts
/search/metadata	Level 3	Not available in our API for the moment
/doc/api	Level 1