Skip to content

Commit 90810ef

Browse files
committed
Add displayOnCreate field documentation and release note snippet
- Add release note snippet for displayOnCreate field feature - Update API documentation to clarify displayOnCreate behavior
1 parent 4625a3a commit 90810ef

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
New feature: Collection administrators can now configure which metadata fields appear during dataset creation through the `displayOnCreate` property, even when fields are not required. This provides greater control over metadata visibility and can help improve metadata completeness.
2+
3+
- The feature is currently available through the API endpoint `/api/dataverses/{alias}/inputLevels`
4+
- UI implementation will be available in a future release
5+
6+
For more information, see the [API Guide](https://guides.dataverse.org/en/latest/api/native-api.html#update-collection-input-levels) and issues [#10476](https://github.com/IQSS/dataverse/issues/10476) and [#11224](https://github.com/IQSS/dataverse/pull/11224).

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,15 +1107,23 @@ This endpoint expects a JSON with the following format::
11071107
{
11081108
"datasetFieldTypeName": "datasetFieldTypeName1",
11091109
"required": true,
1110-
"include": true
1110+
"include": true,
1111+
"displayOnCreate": false
11111112
},
11121113
{
11131114
"datasetFieldTypeName": "datasetFieldTypeName2",
11141115
"required": true,
1115-
"include": true
1116+
"include": true,
1117+
"displayOnCreate": true
11161118
}
11171119
]
11181120

1121+
Parameters:
1122+
- ``datasetFieldTypeName``: Name of the metadata field
1123+
- ``required``: Whether the field is required (boolean)
1124+
- ``include``: Whether the field is included (boolean)
1125+
- ``displayOnCreate`` (optional): Whether the field is displayed during dataset creation, even when not required (boolean)
1126+
11191127
.. code-block:: bash
11201128
11211129
export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

0 commit comments

Comments
 (0)