Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = off

[*.rst]
indent_size = 4

[*.bat]
indent_style = tab
end_of_line = crlf
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,15 @@ The code style is captured using [EditorConfig](https://editorconfig.org/), see
### Building the Documentation

First, install the required dependencies (preferably in a virtual environment):
To activate the env in windows use the cmd and venv\Scripts\activate.bat

```bash
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

**Note**: To activate the env on Windows, run in cmd: `venv\Scripts\activate.bat`.

Then, you can build the documentation using the following command:

```bash
Expand Down
7 changes: 7 additions & 0 deletions CONTRIBUTORS.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,10 @@ Paolo Manghi:
github: paolomanghi
orcid: 0000-0001-7291-3210
affiliation: CNR-ISTI

Pablo Alarcón-Moreno:
first_name: Pablo
last_name: Alarcón-Moreno
github: pabloalarconm
orcid: 0000-0001-5974-589X
affiliation: Universidad Politécnica de Madrid
118 changes: 60 additions & 58 deletions docs/commons/FAIR/Assessment-Recommended-API.rst
Original file line number Diff line number Diff line change
@@ -1,78 +1,80 @@
Assessment Recommended API
----------------------------
--------------------------

The FAIR-IF follows, as closely as possible, the REST standard;
however, unlike many REST architectures, not all identifiers in
the IF are “local”, and thus it is often necessary to pass the
full GUID of an identifier from one component to another, or from
client to server. For example, the GUID of a Benchmark is the
DOI of that Benchmark as recorded in the FAIRsharing registry,
and as such, it cannot become part of the URL of the REST interface.
The FAIR-IF follows, as closely as possible, the REST standard;
however, unlike many REST architectures, not all identifiers in
the IF are “local”, and thus it is often necessary to pass the
full GUID of an identifier from one component to another, or from
client to server. For example, the GUID of a Benchmark is the
DOI of that Benchmark as recorded in the FAIRsharing registry,
and as such, it cannot become part of the URL of the REST interface.

Nevertheless, there are two “types” of calls in the FAIR-IF.
Calls that are intended to retrieve information and calls that are
intended to trigger an activity (such as a test or assessment).
The latter kinds of calls are prefixed with /assess/.
Nevertheless, there are two “types” of calls in the FAIR-IF.
Calls that are intended to retrieve information and calls that are
intended to trigger an activity (such as a test or assessment).
The latter kinds of calls are prefixed with /assess/.

Please refer to the paragraphs below for API calls or implementation.
An OpenAPI yaml specification for FTR is available in the following [link](https://github.com/OSTrails/FAIR_testing_resource_vocabulary/blob/main/development/api/open_api_description.yaml) including examples and
Please refer to the paragraphs below for API calls or implementation.
An OpenAPI yaml specification for FTR is available in the following [link](https://github.com/OSTrails/FAIR_testing_resource_vocabulary/blob/main/development/api/open_api_description.yaml) including examples and
method calls.


GET calls
----------------------------
Each of following methods will return metadata of the artifact in JSON-LD,
following the FAIR-IF Application Profile. The method MUST accept a GET
string with key/value as in the table below. The same method MAY accept a JSON
Body as in Table 1, via HTTP POST.
---------

Each of following methods will return metadata of the artifact in JSON-LD,
following the FAIR-IF Application Profile. The method MUST accept a GET
string with key/value as in the table below. The same method MAY accept a JSON
Body as in Table 1, via HTTP POST.

.. list-table:: GET endpoints
:header-rows: 1
:widths: 20 20 60
:header-rows: 1
:widths: 20 20 60

* - Method
- Parameter
- Returns
* - ``/tests/``
- ``testid``
- A list with all the test identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.
* - ``/benchmarks/``
- ``bmid``
- A list with all the benchmark identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.
* - ``/metrics/``
- ``mid``
- A list with all the metrics identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.
* - ``/algorithms/``
- ``aid``
- A list with all the algorithms identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.
* - Method
- Parameter
- Returns
* - ``/tests/``
- ``testid``
- A list with all the test identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.
* - ``/benchmarks/``
- ``bmid``
- A list with all the benchmark identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.
* - ``/metrics/``
- ``mid``
- A list with all the metrics identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.
* - ``/algorithms/``
- ``aid``
- A list with all the algorithms identifiers supported by the tool.
When an id is sent, a DCAT record in JSON-LD is returned.

POST calls
----------------------------
----------

All post requests must submit a body with the resource to assess as follows:

.. code-block:: json

{
"resource_identifier": "https://w3id.org/example#"
}
{
"resource_identifier": "https://w3id.org/example#"
}

.. list-table:: POST endpoints
:header-rows: 1
:widths: 20 20 60
:header-rows: 1
:widths: 20 20 60

* - Method
- Parameter
- Returns
* - ``/assess/test/``
- ``testid`` and ``resource_identifier``
- Test result in JSON-LD
* - ``/assess/benchmark/``
- ``bmid`` and ``resource_identifier``
- Test result in JSON-LD
* - ``/assess/algorithm/``
- ``algoid`` and ``resource_identifier``
- Test result in JSON-LD
* - Method
- Parameter
- Returns
* - ``/assess/test/``
- ``testid`` and ``resource_identifier``
- Test result in JSON-LD
* - ``/assess/benchmark/``
- ``bmid`` and ``resource_identifier``
- Test result in JSON-LD
* - ``/assess/algorithm/``
- ``algoid`` and ``resource_identifier``
- Test result in JSON-LD
8 changes: 1 addition & 7 deletions docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,17 @@ acting as a reference model that extends W3C standards such as
and others to describe the different assessment components, such as:

- **Test**: Service, formed by an API and associated piece of code that implements a Metric, and is executed (by a FAIR assessment tool), retrieving a particular and standardised result.

- **TestResult**: Output of running a test over a resource. A test result should also contain provenance metadata about the process followed to create it. ``TestResult`` is represented as an extension of ``prov:Entity``. A test result points to the corresponding test through the ``ftr:outputFromTest`` property.

- **TestResultSet**: A set of FAIR test results, together with their respective metadata. Common metadata may describe the set. For example, if all results were run by a request to the same API.

- **TestExecutionActivity**: The action carried out by an agent

calling an API in which a test (or set of tests) was run. The result
of this activity is either a ``TestResult`` or a ``TestResultSet``.

- **Metric**: Narrative domain-agnostic description that a Test must wholly implement.

- **Benchmark**: Community-specific groupings of a set of Metrics that provide a narrative describing how that community defines FAIR for assessment purposes.

- **ScoringAlgorithm**: Piece of code that contextualises the sum of all test results for a given benchmark into a final quantitative assessment result.

- **ScoringAlgorithmActivity**: The action carried out by an agent calling an API in which a ``ScoringAlgorithm`` was executed. The result of this activity is a ``BenchmarkScore``.

- **BenchmarkScore**: Output of a Scoring Algorithm over a resource, generating the final score and guidance for the whole assessment.

----
Expand Down
2 changes: 1 addition & 1 deletion docs/commons/FAIR/Guidance-Element-Specification.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
FAIR Guidance Vocabulary Specification (FGV)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The **FAIR Guidance Vocabulary (FGV)** provides a machine-readable ontology that implements the FAIR Guidance Model described in the OSTrails Deliverable D1.3. It formalizes the structure of FAIR-enabling guidance by extending and aligning with standards such as `DCAT <https://www.w3.org/TR/vocab-dcat-3/>`__, `Schema.org <https://schema.org/version/latest>`__, and the `Semanticscience Integrated Ontology (SIO) <http://semanticscience.org/ontology/sio.owl>`__.

Expand Down
10 changes: 0 additions & 10 deletions docs/commons/FAIR/index_catalogs_registries.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/commons/FAIR/index_standards.rst

This file was deleted.

8 changes: 3 additions & 5 deletions docs/commons/dmp/API-specification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ OSTrails maDMP API Specification

The API is developed jointly with the `Research Data Alliance maDMP API working group <https://www.rd-alliance.org/groups/common-application-programming-interface-api-for-machine-actionable-data-management-plans-madmps/activity>`_.

The charter of the group can be found `here <https://www.rd-alliance.org/groups/common-application-programming-interface-api-for-machine-actionable-data-management-plans-madmps/work-statement>`_.
The charter of the group can be found at the `RDA maDMP API WG page <https://www.rd-alliance.org/groups/common-application-programming-interface-api-for-machine-actionable-data-management-plans-madmps/work-statement>`_.


The API specification is in this repository - `click <https://github.com/RDA-DMP-Common/common-madmp-api>`_.
The API specification is in this GitHub repository: `RDA-DMP-Common/common-madmp-api <https://github.com/RDA-DMP-Common/common-madmp-api>`_.



The OpenAPI documentation can be accessed directly `here <https://rda-dmp-common.github.io/common-madmp-api/>`_.
The OpenAPI documentation can be accessed directly at: `rda-dmp-common.github.io/common-madmp-api <https://rda-dmp-common.github.io/common-madmp-api/>`_.


Loading
Loading