Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add displayOrder, typeClass and isRequired fields to DatasetFieldType payload #10225

Merged
merged 5 commits into from
Jan 22, 2024

Conversation

GPortas
Copy link
Contributor

@GPortas GPortas commented Jan 11, 2024

What this PR does / why we need it:

The API endpoint /api/metadatablocks/{block_id} has been extended to include the following fields:

  • isRequired - Wether or not this field is required
  • displayOrder: The display order of the field in create/edit forms
  • typeClass: The type class of this field ("controlledVocabulary", "compound", or "primitive")

Which issue(s) this PR closes:

Suggestions on how to test this:

curl http://localhost:8080/api/v1/metadatablocks/citation

See how citation fields subJson contains the new 'isRequired' and 'displayOrder' fields.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No

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

Yes.

@coveralls
Copy link

coveralls commented Jan 11, 2024

Coverage Status

coverage: 20.153%. remained the same
when pulling 0f4a455 on 10216-metadatablocks-payload-extension
into e5e232d on develop.

This comment has been minimized.

1 similar comment

This comment has been minimized.

@GPortas GPortas marked this pull request as ready for review January 11, 2024 12:06
@GPortas GPortas added Size: 3 A percentage of a sprint. 2.1 hours. pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows SPA These changes are required for the Dataverse SPA labels Jan 11, 2024
@sekmiller sekmiller self-assigned this Jan 11, 2024
Copy link
Contributor

@sekmiller sekmiller 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. I just made a fix to a typo in the release note

@sekmiller sekmiller removed their assignment Jan 11, 2024

This comment has been minimized.

@GPortas
Copy link
Contributor Author

GPortas commented Jan 17, 2024

@sekmiller

I have added another required field to the payload so I have moved this PR back to ready for review.

@GPortas GPortas changed the title Add displayOrder and isRequired fields to DatasetFieldType payload Add displayOrder, typeClass and isRequired fields to DatasetFieldType payload Jan 17, 2024
Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10216-metadatablocks-payload-extension
ghcr.io/gdcc/configbaker:10216-metadatablocks-payload-extension

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

@sekmiller sekmiller self-assigned this Jan 18, 2024
@sekmiller sekmiller removed their assignment Jan 18, 2024
@stevenwinship stevenwinship self-assigned this Jan 22, 2024
@stevenwinship stevenwinship merged commit e8af210 into develop Jan 22, 2024
19 checks passed
@stevenwinship stevenwinship deleted the 10216-metadatablocks-payload-extension branch January 22, 2024 14:34
@pdurbin pdurbin added this to the 6.2 milestone Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 3 A percentage of a sprint. 2.1 hours. SPA These changes are required for the Dataverse SPA
Projects
Status: Done 🧹
5 participants