Improved doc
This commit is contained in:
parent
0e40f2aa03
commit
2b4a7bbf26
|
@ -425,7 +425,8 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @pathExample /items/my_test_item
|
* @pathExample /items/my_test_item
|
||||||
* @responseExample application/json;charset=UTF-8 classpath:/read-item-response.json
|
* @requestExample application/json;charset=UTF-8 classpath:/update-item-request.json
|
||||||
|
* @responseExample application/json;charset=UTF-8 classpath:/update-item-response.json
|
||||||
*/
|
*/
|
||||||
@PUT
|
@PUT
|
||||||
@Path("/{" + ITEM_ID_PARAMETER + "}")
|
@Path("/{" + ITEM_ID_PARAMETER + "}")
|
||||||
|
@ -442,7 +443,8 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @pathExample /items/my_test_item
|
* @pathExample /items/my_test_item
|
||||||
* @responseExample application/json;charset=UTF-8 classpath:/read-item-response.json
|
* @requestExample application/json;charset=UTF-8 classpath:/patch-item-request.json
|
||||||
|
* @responseExample application/json;charset=UTF-8 classpath:/patch-item-response.json
|
||||||
*/
|
*/
|
||||||
@PATCH
|
@PATCH
|
||||||
@Path("/{" + ITEM_ID_PARAMETER + "}")
|
@Path("/{" + ITEM_ID_PARAMETER + "}")
|
||||||
|
|
|
@ -6,14 +6,14 @@
|
||||||
"private": false,
|
"private": false,
|
||||||
"maintainer_email": "luca.frosini@isti.cnr.it",
|
"maintainer_email": "luca.frosini@isti.cnr.it",
|
||||||
"num_tags": 1,
|
"num_tags": 1,
|
||||||
"id": "09db787f-d673-4c99-985f-dd16103332ad",
|
"id": "93b3e578-5cb2-4560-adcb-5512f2449b98",
|
||||||
"metadata_created": "2022-09-27T12:53:10.312673",
|
"metadata_created": "2022-09-27T13:54:23.505142",
|
||||||
"metadata_modified": "2022-09-27T12:53:10.312680",
|
"metadata_modified": "2022-09-27T13:54:23.505150",
|
||||||
"author": "Frosini Luca",
|
"author": "Frosini Luca",
|
||||||
"author_email": "luca.frosini@isti.cnr.it",
|
"author_email": "luca.frosini@isti.cnr.it",
|
||||||
"state": "active",
|
"state": "active",
|
||||||
"version": null,
|
"version": null,
|
||||||
"creator_user_id": "287b2eec-4cd7-4e50-817f-e6dce19995c7",
|
"creator_user_id": "aabddbb0-b761-4f30-9629-3ca2fdc08eb4",
|
||||||
"type": "dataset",
|
"type": "dataset",
|
||||||
"resources": [],
|
"resources": [],
|
||||||
"num_resources": 0,
|
"num_resources": 0,
|
||||||
|
@ -22,14 +22,26 @@
|
||||||
"vocabulary_id": null,
|
"vocabulary_id": null,
|
||||||
"state": "active",
|
"state": "active",
|
||||||
"display_name": "Test",
|
"display_name": "Test",
|
||||||
"id": "78f1cb4b-dfe8-43e4-af0d-e874034a1316",
|
"id": "fec9de86-51a2-41b0-aef4-ba06eb39e16d",
|
||||||
"name": "Test"
|
"name": "Test"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"groups": [],
|
"groups": [],
|
||||||
"license_id": "CC-BY-SA-4.0",
|
"license_id": "CC-BY-SA-4.0",
|
||||||
"relationships_as_subject": [],
|
"relationships_as_subject": [],
|
||||||
"organization": { ... },
|
"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",
|
"name": "my_test_item",
|
||||||
"isopen": true,
|
"isopen": true,
|
||||||
"url": "http://www.d4science.org",
|
"url": "http://www.d4science.org",
|
||||||
|
@ -37,7 +49,7 @@
|
||||||
"extras": [
|
"extras": [
|
||||||
{
|
{
|
||||||
"key": "Item URL",
|
"key": "Item URL",
|
||||||
"value": "https://.....d4science.org/ctlg/...../my_test_item"
|
"value": "https://data.dev.d4science.org/ctlg/devVRE/my_test_item"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"key": "Language",
|
"key": "Language",
|
||||||
|
@ -51,5 +63,5 @@
|
||||||
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
||||||
"ratings_count": 0,
|
"ratings_count": 0,
|
||||||
"title": "My Test Item",
|
"title": "My Test Item",
|
||||||
"revision_id": "939e1d97-f497-4ab5-86ed-d6d9c3ec7604"
|
"revision_id": "47af0aa8-bf5e-4ff8-adf3-d2f120cbd4a5"
|
||||||
}
|
}
|
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"name": "my_test_item",
|
||||||
|
"title": "Patched Title of My Test Item"
|
||||||
|
}
|
|
@ -0,0 +1,67 @@
|
||||||
|
{
|
||||||
|
"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": "93b3e578-5cb2-4560-adcb-5512f2449b98",
|
||||||
|
"metadata_created": "2022-09-27T13:54:23.505142",
|
||||||
|
"metadata_modified": "2022-09-27T13:57:28.825790",
|
||||||
|
"author": "Frosini Luca",
|
||||||
|
"author_email": "luca.frosini@isti.cnr.it",
|
||||||
|
"state": "active",
|
||||||
|
"version": null,
|
||||||
|
"creator_user_id": "aabddbb0-b761-4f30-9629-3ca2fdc08eb4",
|
||||||
|
"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",
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "Language",
|
||||||
|
"value": "EN"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "system:type",
|
||||||
|
"value": "EmptyProfile"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
||||||
|
"ratings_count": 0,
|
||||||
|
"title": "Patched Title of My Test Item",
|
||||||
|
"revision_id": "65c6bce2-c5c6-47e9-9264-5891abe78000"
|
||||||
|
}
|
|
@ -6,14 +6,14 @@
|
||||||
"private": false,
|
"private": false,
|
||||||
"maintainer_email": "luca.frosini@isti.cnr.it",
|
"maintainer_email": "luca.frosini@isti.cnr.it",
|
||||||
"num_tags": 1,
|
"num_tags": 1,
|
||||||
"id": "09db787f-d673-4c99-985f-dd16103332ad",
|
"id": "93b3e578-5cb2-4560-adcb-5512f2449b98",
|
||||||
"metadata_created": "2022-09-27T12:53:10.312673",
|
"metadata_created": "2022-09-27T13:54:23.505142",
|
||||||
"metadata_modified": "2022-09-27T12:53:10.312680",
|
"metadata_modified": "2022-09-27T13:54:23.505150",
|
||||||
"author": "Frosini Luca",
|
"author": "Frosini Luca",
|
||||||
"author_email": "luca.frosini@isti.cnr.it",
|
"author_email": "luca.frosini@isti.cnr.it",
|
||||||
"state": "active",
|
"state": "active",
|
||||||
"version": null,
|
"version": null,
|
||||||
"creator_user_id": "287b2eec-4cd7-4e50-817f-e6dce19995c7",
|
"creator_user_id": "aabddbb0-b761-4f30-9629-3ca2fdc08eb4",
|
||||||
"type": "dataset",
|
"type": "dataset",
|
||||||
"resources": [],
|
"resources": [],
|
||||||
"num_resources": 0,
|
"num_resources": 0,
|
||||||
|
@ -22,14 +22,26 @@
|
||||||
"vocabulary_id": null,
|
"vocabulary_id": null,
|
||||||
"state": "active",
|
"state": "active",
|
||||||
"display_name": "Test",
|
"display_name": "Test",
|
||||||
"id": "78f1cb4b-dfe8-43e4-af0d-e874034a1316",
|
"id": "fec9de86-51a2-41b0-aef4-ba06eb39e16d",
|
||||||
"name": "Test"
|
"name": "Test"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"groups": [],
|
"groups": [],
|
||||||
"license_id": "CC-BY-SA-4.0",
|
"license_id": "CC-BY-SA-4.0",
|
||||||
"relationships_as_subject": [],
|
"relationships_as_subject": [],
|
||||||
"organization": { ... },
|
"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",
|
"name": "my_test_item",
|
||||||
"isopen": true,
|
"isopen": true,
|
||||||
"url": "http://www.d4science.org",
|
"url": "http://www.d4science.org",
|
||||||
|
@ -37,7 +49,7 @@
|
||||||
"extras": [
|
"extras": [
|
||||||
{
|
{
|
||||||
"key": "Item URL",
|
"key": "Item URL",
|
||||||
"value": "https://.....d4science.org/ctlg/...../my_test_item"
|
"value": "https://data.dev.d4science.org/ctlg/devVRE/my_test_item"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"key": "Language",
|
"key": "Language",
|
||||||
|
@ -51,5 +63,5 @@
|
||||||
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
||||||
"ratings_count": 0,
|
"ratings_count": 0,
|
||||||
"title": "My Test Item",
|
"title": "My Test Item",
|
||||||
"revision_id": "939e1d97-f497-4ab5-86ed-d6d9c3ec7604"
|
"revision_id": "47af0aa8-bf5e-4ff8-adf3-d2f120cbd4a5"
|
||||||
}
|
}
|
|
@ -0,0 +1,67 @@
|
||||||
|
{
|
||||||
|
"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": "93b3e578-5cb2-4560-adcb-5512f2449b98",
|
||||||
|
"metadata_created": "2022-09-27T13:54:23.505142",
|
||||||
|
"metadata_modified": "2022-09-27T13:54:23.505150",
|
||||||
|
"author": "Frosini Luca",
|
||||||
|
"author_email": "luca.frosini@isti.cnr.it",
|
||||||
|
"state": "active",
|
||||||
|
"version": null,
|
||||||
|
"creator_user_id": "aabddbb0-b761-4f30-9629-3ca2fdc08eb4",
|
||||||
|
"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",
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "Language",
|
||||||
|
"value": "EN"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "system:type",
|
||||||
|
"value": "EmptyProfile"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
||||||
|
"ratings_count": 0,
|
||||||
|
"title": "Updated title of My Test Item",
|
||||||
|
"revision_id": "47af0aa8-bf5e-4ff8-adf3-d2f120cbd4a5"
|
||||||
|
}
|
|
@ -0,0 +1,67 @@
|
||||||
|
{
|
||||||
|
"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": "93b3e578-5cb2-4560-adcb-5512f2449b98",
|
||||||
|
"metadata_created": "2022-09-27T13:54:23.505142",
|
||||||
|
"metadata_modified": "2022-09-27T13:56:52.746494",
|
||||||
|
"author": "Frosini Luca",
|
||||||
|
"author_email": "luca.frosini@isti.cnr.it",
|
||||||
|
"state": "active",
|
||||||
|
"version": null,
|
||||||
|
"creator_user_id": "aabddbb0-b761-4f30-9629-3ca2fdc08eb4",
|
||||||
|
"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",
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "Language",
|
||||||
|
"value": "EN"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "system:type",
|
||||||
|
"value": "EmptyProfile"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
|
||||||
|
"ratings_count": 0,
|
||||||
|
"title": "Updated title of My Test Item",
|
||||||
|
"revision_id": "bfa50b95-e936-4843-a405-3d6ff7e427aa"
|
||||||
|
}
|
Loading…
Reference in New Issue