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

Extend 'metadatablocks/{block_id}' endpoint JSON output to include 'isRequired', 'typeClass' and 'displayOrder' fields #10216

Closed
GPortas opened this issue Jan 9, 2024 · 0 comments · Fixed by #10225
Assignees
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 User Role: API User Makes use of APIs
Milestone

Comments

@GPortas
Copy link
Contributor

GPortas commented Jan 9, 2024

Overview of the Feature Request

The goal is to extend the API endpoint /api/metadatablocks/{block_id} to include the following fields in its response:

  • isRequired: To know if the field is required to create a dataset
  • displayOrder: The display order in the creation / edit forms
  • typeClass: The type class of this field ("controlledVocabulary", "compound", or "primitive")

The second param is necessary for the SPA, and the first one not only for the SPA but also for any other frontend application that aims to create a dataset.

The third one is necessary for dataset creation, since it is a property included for each metadata field value in the json sent to the backend via POST.

What kind of user is the feature intended for?
API User

What inspired the request?

What existing behavior do you want changed?
None

Any brand new behavior do you want to add to Dataverse?
New fields in 'metadatablocks/{block_id}' response

Any open or closed issues related to this feature request?

@GPortas GPortas added User Role: API User Makes use of APIs 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 9, 2024
@GPortas GPortas self-assigned this Jan 10, 2024
GPortas added a commit that referenced this issue Jan 11, 2024
sekmiller added a commit that referenced this issue Jan 11, 2024
@GPortas GPortas changed the title Extend 'metadatablocks/{block_id}' endpoint JSON output to include 'isRequired' and 'displayOrder' fields Extend 'metadatablocks/{block_id}' endpoint JSON output to include 'isRequired', 'typeClass' and 'displayOrder' fields Jan 17, 2024
stevenwinship pushed a commit that referenced this issue Jan 22, 2024
stevenwinship pushed a commit that referenced this issue Jan 22, 2024
@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 User Role: API User Makes use of APIs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants