improving gcat documentation
This commit is contained in:
parent
9fa254add0
commit
4ef0cb2112
157
docs/index.rst
157
docs/index.rst
|
|
@ -7,42 +7,6 @@ gCat is a RESTful application which exposes operations via REST-API.
|
|||
|
||||
See the available `REST-API docs <../api-docs/index.html>`_.
|
||||
|
||||
The maven coordinates are:
|
||||
|
||||
.. code:: xml
|
||||
|
||||
<groupId>org.gcube.data-catalogue</groupId>
|
||||
<artifactId>gcat</artifactId>
|
||||
|
||||
|
||||
The service can be discovered in the gCore IS as gCore Endpoint with the following parameter:
|
||||
|
||||
.. code:: xml
|
||||
|
||||
<ServiceClass>org.gcube.data-catalogue</ServiceClass>
|
||||
<ServiceName>gcat</ServiceName>
|
||||
|
||||
|
||||
The service can be discovered in the Facet Based IS as EService with the following json query:
|
||||
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
"@class": "EService",
|
||||
"consistsOf": [
|
||||
{
|
||||
"@class": "IsIdentifiedBy",
|
||||
"target": {
|
||||
"@class": "SoftwareFacet",
|
||||
"group": "org.gcube.data-catalogue",
|
||||
"name": "gcat"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
|
||||
Base URL
|
||||
========
|
||||
|
||||
|
|
@ -405,9 +369,81 @@ The service exposes `its methods <../api-docs/index.html>`_ using a standard nam
|
|||
|
||||
.. code:: javascript
|
||||
|
||||
{
|
||||
....
|
||||
}
|
||||
{
|
||||
"rating": 0.0,
|
||||
"license_title": "Creative Commons Attribution Share-Alike 4.0",
|
||||
"maintainer": "Frosini Luca",
|
||||
"relationships_as_object": [],
|
||||
"private": false,
|
||||
"maintainer_email": "luca.frosini@isti.cnr.it",
|
||||
"num_tags": 1,
|
||||
"id": "17051d86-c127-4928-9296-d3d7590161fe",
|
||||
"metadata_created": "2022-10-17T12:45:53.118318",
|
||||
"metadata_modified": "2022-10-18T10:30:03.362756",
|
||||
"author": "Frosini Luca",
|
||||
"author_email": "luca.frosini@isti.cnr.it",
|
||||
"state": "active",
|
||||
"version": null,
|
||||
"creator_user_id": "f1b0265c-9983-4f97-a7b6-be3cc0544b27",
|
||||
"type": "dataset",
|
||||
"resources": [],
|
||||
"num_resources": 0,
|
||||
"tags": [
|
||||
{
|
||||
"vocabulary_id": null,
|
||||
"state": "active",
|
||||
"display_name": "Test",
|
||||
"id": "fec9de86-51a2-41b0-aef4-ba06eb39e16d",
|
||||
"name": "Test"
|
||||
}
|
||||
],
|
||||
"groups": [],
|
||||
"license_id": "CC-BY-SA-4.0",
|
||||
"relationships_as_subject": [],
|
||||
"organization": {
|
||||
"description": "",
|
||||
"created": "2016-05-30T11:30:41.710079",
|
||||
"title": "devVRE",
|
||||
"name": "devvre",
|
||||
"is_organization": true,
|
||||
"state": "active",
|
||||
"image_url": "",
|
||||
"revision_id": "a7eee485-a6d5-4a7b-8f73-b0ed999d5b03",
|
||||
"type": "organization",
|
||||
"id": "3571cca5-b0ae-4dc6-b791-434a8e062ce5",
|
||||
"approval_status": "approved"
|
||||
},
|
||||
"name": "my_test_item_devvre",
|
||||
"isopen": true,
|
||||
"url": "http://www.d4science.org",
|
||||
"notes": "A test item of Luca Frosini",
|
||||
"extras": [
|
||||
{
|
||||
"key": "Item URL",
|
||||
"value": "https://data.dev.d4science.org/ctlg/devVRE/my_test_item_devvre"
|
||||
},
|
||||
{
|
||||
"key": "Language",
|
||||
"value": "EN"
|
||||
},
|
||||
{
|
||||
"key": "system:cm_item_status",
|
||||
"value": "approved"
|
||||
},
|
||||
{
|
||||
"key": "system:cm_item_visibility",
|
||||
"value": "public"
|
||||
},
|
||||
{
|
||||
"key": "system:type",
|
||||
"value": "EmptyProfile"
|
||||
}
|
||||
],
|
||||
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
||||
"ratings_count": 0,
|
||||
"title": "My Test Item",
|
||||
"revision_id": "bc0d1f2a-4e97-4810-b951-8b72e8279719"
|
||||
}
|
||||
|
||||
*Inputs are automatically validated before the request is served.*
|
||||
|
||||
|
|
@ -425,3 +461,46 @@ The service exposes `its methods <../api-docs/index.html>`_ using a standard nam
|
|||
int count = item.count();
|
||||
...
|
||||
|
||||
|
||||
|
||||
Service Discovery on IS
|
||||
=======================
|
||||
|
||||
The service can be discovered in the gCore IS as gCore Endpoint with the following parameter:
|
||||
|
||||
.. code:: xml
|
||||
|
||||
<ServiceClass>org.gcube.data-catalogue</ServiceClass>
|
||||
<ServiceName>gcat</ServiceName>
|
||||
|
||||
|
||||
The service can be discovered in the Facet Based IS as EService with the following json query:
|
||||
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
"@class": "EService",
|
||||
"consistsOf": [
|
||||
{
|
||||
"@class": "IsIdentifiedBy",
|
||||
"target": {
|
||||
"@class": "SoftwareFacet",
|
||||
"group": "org.gcube.data-catalogue",
|
||||
"name": "gcat"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
|
||||
Service Maven Coordinates
|
||||
=========================
|
||||
|
||||
The maven coordinates of gCat service are:
|
||||
|
||||
.. code:: xml
|
||||
|
||||
<groupId>org.gcube.data-catalogue</groupId>
|
||||
<artifactId>gcat</artifactId>
|
||||
|
||||
Loading…
Reference in New Issue