Skip to content

9667 - displayFormat added to DatasetFieldType API payload#9668

Merged
kcondon merged 1 commit intodevelopfrom
9667-metadatablocks-api-extension
Jul 10, 2023
Merged

9667 - displayFormat added to DatasetFieldType API payload#9668
kcondon merged 1 commit intodevelopfrom
9667-metadatablocks-api-extension

Conversation

@GPortas
Copy link
Contributor

@GPortas GPortas commented Jun 21, 2023

What this PR does / why we need it:

Add displayFormat to the metadata block fields payload, as required by IQSS/dataverse-client-javascript#63

Which issue(s) this PR closes:

Special notes for your reviewer:

N/A

Suggestions on how to test this:

New field retrieval can be tested via curl:

curl -H "X-Dataverse-Key: <API_KEY>" -X GET http://localhost:8080/api/v1/metadatablocks/citation

Is there a release notes update needed for this change?:

Not sure, since it is a very simple addition. I have added a release note md, just in case.

Additional documentation:

N/A

@coveralls
Copy link

Coverage Status

coverage: 20.419%. remained the same when pulling 2410735 on 9667-metadatablocks-api-extension into 8a293c9 on develop.

@github-actions
Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:9667-metadatablocks-api-extension
ghcr.io/gdcc/configbaker:9667-metadatablocks-api-extension

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

@cmbz cmbz added the Size: 3 A percentage of a sprint. 2.1 hours. label Jul 5, 2023
Copy link
Member

@qqmyers qqmyers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - just requesting text changes in the release note contribution.

@@ -0,0 +1 @@
DatasetFieldType attribute "displayFormat", is now returned by the API.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should reference the API call involved and make it clearer that goes in the backward compatibility section

@kcondon kcondon self-assigned this Jul 10, 2023
@kcondon kcondon merged commit 13794a9 into develop Jul 10, 2023
@kcondon kcondon deleted the 9667-metadatablocks-api-extension branch July 10, 2023 18:07
@pdurbin pdurbin added this to the 5.14 milestone Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Size: 3 A percentage of a sprint. 2.1 hours.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Spike - API] Add displayFormat to the metadata block fields payload

6 participants