Merge branch 'develop' into 11998-features-in-guides

Author: pdurbin

doc/release-notes/12014-croissant-1.1.md

@@ -0,0 +1,25 @@
+### Croissant 1.1 (Summary Statistics)
+
+The Croissant metadata export format has been updated from version 1.0 to 1.1.
+
+Summary statistics (mean, min, max, etc.) are now included for tabular files that were successfully ingested.
+
+You can download an example Croissant file from the [Supported Metadata Export Formats](https://dataverse-guide--12214.org.readthedocs.build/en/12214/user/dataset-management.html#supported-metadata-export-formats) section of the guides.
+
+Minor backward-incompatible changes were made, which are noted below.
+
+See #12014 and #12214
+
+## Backward Incompatible Changes
+
+Generally speaking, see the [API Changelog](https://guides.dataverse.org/en/latest/api/changelog.html) for a list of backward-incompatible API changes.
+
+Minor changes in the `croissant` format are noted in the [API changelog](https://dataverse-guide--12214.org.readthedocs.build/en/12214/api/changelog.html).
+
+## Upgrade Instructions
+
+1. Re-export metadata export formats
+
+   We re-export because the Croissant format was updated.
+
+   `curl http://localhost:8080/api/admin/metadata/reExportAll`

doc/release-notes/12070-datacite-getmetadata.md

@@ -0,0 +1,11 @@
+Incremental improvements have been made to the process of registering dataset metadata with DataCite. If your instance is using DataCite, please make sure you have a valid DataCite REST API url configured, since it is now required.
+
+The JVM option(s) in question are `dataverse.pid.*.datacite.rest-api-url` if the recommended, new-style pid configuration is used, or `doi.dataciterestapiurlstring` if the legacy settings are in place. In the latter case however, this may be a good occasion to switch to the new configuration setup.
+
+For instances using registered DataCite authorities in production the url should be:
+
+```<jvm-options>-Ddataverse.pid.<providername>.datacite.rest-api-url=https://api.datacite.org</jvm-options>```
+
+Or, for test and development instances:
+
+```<jvm-options>-Ddataverse.pid.<providername>.datacite.rest-api-url=https://api.test.datacite.org</jvm-options>```

doc/release-notes/12112-get-default-contributor-role.md

@@ -0,0 +1 @@
+A new API endpoint for getting the default contributor role of a collection (`GET /api/dataverses/$ID/defaultContributorRole`) was added.

doc/release-notes/12268-direct-upload-support-legacy-lowercase-dois.md

@@ -0,0 +1 @@
+Fixed a problem with S3 direct upload to datasets which using lower- or mixed-case PID authority/identifier in the database and to datasets using an alternative identifier for file storage.

doc/release-notes/360-modify-notvalid-deaccession-reason.md

@@ -0,0 +1,16 @@
+# Language change for file.deaccessionDialog.reason.selectItem.notValid
+
+"Not a valid dataset." is being changed to "Not valid. This dataset does not comply with repository policies."
+This is the default English language version. For installations using customized languages, replacing the Bundle.properties file, please follow these manual instructions to make this modification, if desired.
+
+Make the change to the Bundle_##.properties file with the new verbiage. Either locally or as an update to [dataverse-language-packs Repo](https://github.com/GlobalDataverseCommunityConsortium/dataverse-language-packs/tree/develop)
+
+The SQL statements to modify the datasets is:
+
+- `UPDATE dvobject SET indextime=null WHERE id in (SELECT dataset_id FROM datasetversion WHERE deaccessionnote='Not a valid dataset.');`
+
+- `UPDATE datasetversion SET deaccessionnote='Not valid. This dataset does not comply with repository policies.' WHERE deaccessionnote='Not a valid dataset.';`
+
+Once the database is updated the Solr indexes need to be rebuilt using the following Admin API:
+
+- `curl http://localhost:8080/api/admin/index`

doc/sphinx-guides/source/api/changelog.rst

@@ -7,6 +7,11 @@ This API changelog is experimental and we would love feedback on its usefulness.
     :local:
     :depth: 1
 
+v6.11
+-----
+
+- The Croissant :ref:`metadata export format <metadata-export-formats>` has been updated from version 1.0 to 1.1, which is reflected in the ``conformsTo`` property. ``@vocab`` and ``sc`` properties now use "http" as `recommended <https://github.com/mlcommons/croissant/pull/929#pullrequestreview-3079137662>`_. The unused ``wd`` property has been dropped.
+
 v6.10
 -----
 - The following GET APIs will now return ``400`` if a required Guestbook Response is not supplied. A Guestbook Response can be passed to these APIs in the JSON body using a POST call. See the notes under :ref:`basic-file-access` and :ref:`download-by-dataset-by-version` for details.

doc/sphinx-guides/source/api/native-api.rst

@@ -525,7 +525,7 @@ The fully expanded example above (without environment variables) looks like this
 Assign Default Role to User Creating a Dataset in a Dataverse Collection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Assign a default role to a user creating a dataset in a Dataverse collection ``id`` where ``roleAlias`` is the database alias of the role to be assigned:
+Assign a default role to a user creating a dataset in a Dataverse collection ``id`` where ``roleAlias`` is the database alias of the role to be assigned (requires ``ManageDataversePermissions``):
 
 .. code-block:: bash
 
@@ -544,6 +544,27 @@ The fully expanded example above (without environment variables) looks like this
 
 Note: You may use "none" as the ``ROLE_ALIAS``. This will prevent a user who creates a dataset from having any role on that dataset. It is not recommended for Dataverse collections with human contributors.
 
+.. _get-default-contributor-role-on-a-dataverse-api:
+
+Get Default Role Assigned to User Creating a Dataset in a Dataverse Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Get the default role that is assigned to a user creating a dataset in a Dataverse collection ``id`` (requires ``ManageDataversePermissions``):
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export ID=root
+
+  curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/dataverses/$ID/defaultContributorRole"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "https://demo.dataverse.org/api/dataverses/root/defaultContributorRole"
+
 .. _assign-role-on-a-dataverse-api:
 
 Assign a New Role on a Dataverse Collection
@@ -8852,51 +8873,58 @@ Note that this API is probably only useful for testing.
 MyData
 ------
 
-The MyData API is used to get a list of just the datasets, dataverses or datafiles an authenticated user can edit.
+The MyData API is used to get a list of just the datasets, collections (dataverses), or datafiles an authenticated user has a role on.
 
-The API excludes dataverses linked to an harvesting client. This results in `a known issue <https://github.com/IQSS/dataverse/issues/11083>`_ where regular datasets in harvesting dataverses are missing from the results.
+The API excludes collections linked to an harvesting client. This results in `a known issue <https://github.com/IQSS/dataverse/issues/11083>`_ where regular datasets in harvesting collections are missing from the results.
 
-A curl example listing objects
+Here is a curl example.
 
 .. code-block:: bash
 
   export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
   export SERVER_URL=https://demo.dataverse.org
-  export ROLE_IDS=6
-  export DVOBJECT_TYPES=Dataset
-  export PUBLISHED_STATES=Unpublished
+  export ROLE_ID1=6
+  export ROLE_ID2=8
+  export DVTYPE1=Dataset
+  export DVTYPE2=Dataverse
+  export PUBLISHED_STATE1=Unpublished
+  export PUBLISHED_STATE2=Published
   export PER_PAGE=10
 
-  curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/mydata/retrieve?role_ids=$ROLE_IDS&dvobject_types=$DVOBJECT_TYPES&published_states=$PUBLISHED_STATES&per_page=$PER_PAGE"
-
-Parameters:
-
-``role_id`` Roles are customizable. Standard roles include:
+  curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/mydata/retrieve?role_ids=$ROLE_ID1&role_ids=$ROLE_ID2&dvobject_types=$DVTYPE1&dvobject_types=$DVTYPE2&published_states=$PUBLISHED_STATE1&published_states=$PUBLISHED_STATE2&per_page=$PER_PAGE"
 
-- ``1`` = Admin
-- ``2`` = File Downloader
-- ``3`` = Dataverse + Dataset Creator
-- ``4`` = Dataverse Creator
-- ``5`` = Dataset Creator
-- ``6`` = Contributor
-- ``7`` = Curator
-- ``8`` = Member
-
-``dvobject_types`` Type of object, several possible values among: ``DataFile`` , ``Dataset`` & ``Dataverse`` .
-
-``published_states`` State of the object, several possible values among:``Published`` , ``Unpublished`` , ``Draft`` , ``Deaccessioned`` & ``In+Review`` .
-
-``per_page`` Number of results returned per page.
-
-``metadata_fields`` Includes the requested fields for each dataset in the response. Multiple "metadata_fields" parameters can be used to include several fields. See :doc:`search` for further information on this parameter.
+The fully expanded example above (without environment variables) looks like this:
 
-``show_collections`` Whether or not to include a list of parent and linked collections for each dataset search result.
+.. code-block:: bash
 
-``sort`` The sort field. Supported values include "name", "date" and "relevance".
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "https://demo.dataverse.org/api/mydata/retrieve?role_ids=6&role_ids=8&dvobject_types=Dataset&published_states=Unpublished&published_states=Published&per_page=10"
 
-``order`` The order in which to sort. Can either be "asc" or "desc".
+**Parameters:**
 
-``fq`` A filter query to filter the list returned. Multiple "fq" parameters can be used.
+- ``role_ids``: Roles are customizable. Multiple "role_ids" parameters can be used to include several roles. Standard roles include:
+    - ``1`` = Admin
+    - ``2`` = File Downloader
+    - ``3`` = Dataverse + Dataset Creator
+    - ``4`` = Dataverse Creator
+    - ``5`` = Dataset Creator
+    - ``6`` = Contributor
+    - ``7`` = Curator
+    - ``8`` = Member
+- ``dvobject_types``: Type of object. Multiple "dvobject_types" parameters can be used to include several types. Possible values:
+    - ``Dataverse``
+    - ``Dataset``
+    - ``DataFile``
+- ``published_states``: State of the object. Multiple "published_states" parameters can be used to include several states. Possible values:
+    - ``Published``
+    - ``Unpublished``
+    - ``Draft``
+    - ``Deaccessioned``
+    - ``In+Review`` (the ``+`` represents a space)
+- ``mydata_search_term``: A string used to search for specific data within the user's MyData collection.
+- ``selected_page``: The page number of results to return (used for pagination).
+- ``per_page``: Number of results returned per page.
+- ``order``: The order in which to sort. Can either be "asc" or "desc".
+- ``fq``: A filter query (Solr syntax) to narrow the list returned. Multiple "fq" parameters can be used.
 
 MyData Collection List
 ~~~~~~~~~~~~~~~~~~~~~~