From a7b428862b42d0b69a0054fcb00ec40bcc6b51f8 Mon Sep 17 00:00:00 2001 From: Kim Jin Yeon Date: Mon, 3 Jul 2023 12:43:57 +0900 Subject: [PATCH 1/7] Add description on Basic File Aceess about FilePIDsEnabled --- doc/sphinx-guides/source/api/dataaccess.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/api/dataaccess.rst b/doc/sphinx-guides/source/api/dataaccess.rst index e76ea167587..98df2d5a046 100755 --- a/doc/sphinx-guides/source/api/dataaccess.rst +++ b/doc/sphinx-guides/source/api/dataaccess.rst @@ -83,7 +83,7 @@ Basic access URI: ``/api/access/datafile/$id`` -.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. +.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. (FilePIDsEnabled 옵션이 켜져 있을 때만 동작하는 것 언급하고 FilePIDsEnabled 설명 문서 링크 첨부하기) Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* :: From e3fd94502d4bc60541cd233847e92367d4be054d Mon Sep 17 00:00:00 2001 From: Minji Woo Date: Mon, 3 Jul 2023 13:05:52 +0900 Subject: [PATCH 2/7] Update dataaccess.rst file access General description of the basic file access: FilePIDsEnabled --- doc/sphinx-guides/source/api/dataaccess.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/api/dataaccess.rst b/doc/sphinx-guides/source/api/dataaccess.rst index 98df2d5a046..2ecdc0d2a23 100755 --- a/doc/sphinx-guides/source/api/dataaccess.rst +++ b/doc/sphinx-guides/source/api/dataaccess.rst @@ -83,7 +83,7 @@ Basic access URI: ``/api/access/datafile/$id`` -.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. (FilePIDsEnabled 옵션이 켜져 있을 때만 동작하는 것 언급하고 FilePIDsEnabled 설명 문서 링크 첨부하기) +.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* :: From 89353d4fb8135b5f957cea799bc5347c6ae9c556 Mon Sep 17 00:00:00 2001 From: kmina02 <79454352+kmina02@users.noreply.github.com> Date: Mon, 3 Jul 2023 13:12:14 +0900 Subject: [PATCH 3/7] Update dataaccess.rst put further link about FilePIDsEnabled --- doc/sphinx-guides/source/api/dataaccess.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/api/dataaccess.rst b/doc/sphinx-guides/source/api/dataaccess.rst index 2ecdc0d2a23..15a93ab436a 100755 --- a/doc/sphinx-guides/source/api/dataaccess.rst +++ b/doc/sphinx-guides/source/api/dataaccess.rst @@ -84,7 +84,7 @@ Basic access URI: ``/api/access/datafile/$id`` .. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. - +For further information, refer to https://guides.dataverse.org/en/5.13/installation/config.html?highlight=filepidsenabled#id255 Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* :: GET http://$SERVER/api/access/datafile/:persistentId?persistentId=doi:10.5072/FK2/J8SJZB From ca796d785b3470805c98adeb6ed86e843c5059b4 Mon Sep 17 00:00:00 2001 From: Kim Jin Yeon Date: Mon, 3 Jul 2023 13:22:48 +0900 Subject: [PATCH 4/7] Update dataaccess.rst --- doc/sphinx-guides/source/api/dataaccess.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/sphinx-guides/source/api/dataaccess.rst b/doc/sphinx-guides/source/api/dataaccess.rst index 15a93ab436a..e4cde143d29 100755 --- a/doc/sphinx-guides/source/api/dataaccess.rst +++ b/doc/sphinx-guides/source/api/dataaccess.rst @@ -83,8 +83,7 @@ Basic access URI: ``/api/access/datafile/$id`` -.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. -For further information, refer to https://guides.dataverse.org/en/5.13/installation/config.html?highlight=filepidsenabled#id255 +.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. For further information, refer to https://guides.dataverse.org/en/latest/installation/config.html?highlight=pidsenabled Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* :: GET http://$SERVER/api/access/datafile/:persistentId?persistentId=doi:10.5072/FK2/J8SJZB From 20e76599b78b5d77dee89784e99241b4095850b2 Mon Sep 17 00:00:00 2001 From: Kim Jin Yeon Date: Mon, 3 Jul 2023 14:06:03 +0900 Subject: [PATCH 5/7] Update dataaccess.rst --- doc/sphinx-guides/source/api/dataaccess.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/sphinx-guides/source/api/dataaccess.rst b/doc/sphinx-guides/source/api/dataaccess.rst index e4cde143d29..99e7f7eca92 100755 --- a/doc/sphinx-guides/source/api/dataaccess.rst +++ b/doc/sphinx-guides/source/api/dataaccess.rst @@ -84,6 +84,7 @@ Basic access URI: ``/api/access/datafile/$id`` .. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. For further information, refer to https://guides.dataverse.org/en/latest/installation/config.html?highlight=pidsenabled + Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* :: GET http://$SERVER/api/access/datafile/:persistentId?persistentId=doi:10.5072/FK2/J8SJZB From 17290efa53ac7b692a1d851b0d4e10a7d4cd8aea Mon Sep 17 00:00:00 2001 From: Kim Jin Yeon Date: Mon, 3 Jul 2023 14:12:33 +0900 Subject: [PATCH 6/7] Update dataaccess.rst --- doc/sphinx-guides/source/api/dataaccess.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/api/dataaccess.rst b/doc/sphinx-guides/source/api/dataaccess.rst index 99e7f7eca92..7b1feed7814 100755 --- a/doc/sphinx-guides/source/api/dataaccess.rst +++ b/doc/sphinx-guides/source/api/dataaccess.rst @@ -83,7 +83,7 @@ Basic access URI: ``/api/access/datafile/$id`` -.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. For further information, refer to https://guides.dataverse.org/en/latest/installation/config.html?highlight=pidsenabled +.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. For further information, refer to `FilePIDsEnabled `_ Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* :: From 6b3c583c6c2b730bb5ab892010da37e2889d5bbe Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 18 Sep 2023 21:55:47 -0400 Subject: [PATCH 7/7] use a ref #9689 --- doc/sphinx-guides/source/api/dataaccess.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/api/dataaccess.rst b/doc/sphinx-guides/source/api/dataaccess.rst index 7b1feed7814..6a726cdc7b9 100755 --- a/doc/sphinx-guides/source/api/dataaccess.rst +++ b/doc/sphinx-guides/source/api/dataaccess.rst @@ -83,7 +83,7 @@ Basic access URI: ``/api/access/datafile/$id`` -.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. For further information, refer to `FilePIDsEnabled `_ +.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. For further information, refer to :ref:`:FilePIDsEnabled`. Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* ::