DOME-4-0 / Tools-and-Services

This repository is to help with planning and prioritisation of tasks in WP2
0 stars 0 forks source link

POST the URL (or the metadata) of the dataset to the FAIR assessment service. #67

Open n-vc opened 2 years ago

n-vc commented 2 years ago

Changed the name to something clearer. (aka "send the dereferenceable resource address", its permanent identifier)

HTTP POST containing the URL to the object to be assessed.

e.g. GET  <dome-domain>/dataset/<id> or similar should return the metadata for that dataset.
 (content-type expected to be application/ld+json) which coming from the RDF database should be easy.

The OAI-PMH protocol is not a requirement. Neither Datacite metadata harvesting.

OpenAPI entry:

paths:
  /evaluate:
    post:
      tags:
      - FAIR object
      security:
        - basicAuth: []
      description: Evaluate FAIRness of a data object based on its identifier
      operationId: assess_by_id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/body'
            example:
              object_identifier: https://doi.org/10.1594/PANGAEA.908011
              test_debug: true
              metadata_service_endpoint: http://ws.pangaea.de/oai/provider
              metadata_service_type: oai_pmh
              use_datacite: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FAIRResults'
        "400":
          description: Invalid identifier supplied
        "401":
          description: Authentication information is missing or invalid
          headers:
            WWW_Authenticate:
              style: simple
              explode: false
              schema:
                type: string
        "404":
          description: Object not found
      x-openapi-router-controller: fuji_server.controllers.fair_object_controller

The FAIR dataset assessment will come from the reuse or update of several parts of the F-UJI API (web service) for DOME 4.0.

The tool is the result of the FAIRsFAIR “Fostering FAIR Data Practices In Europe” project which received funding from the European Union’s Horizon 2020 project call H2020-INFRAEOSC-2018-2020 (grant agreement 831558).

The simplest and most decoupled way (pure data) is to just send the dataset metadata (expecting W3C DCAT 2 serialised as W3C JSON-LD 1.1 in UTF-8 encoding) to the service to be assessed. (If the dataset was updated in the RDF database then a query for the dataset id returning this serialisation is all that is needed). We can decide later which is more convenient for both sides.

The return could be a JSON (or JSON-LD) report.

n-vc commented 2 years ago

Sending the metadata is an alternative.