Skip to content

API: File Get Citation In Other Formats#12238

Merged
ChengShi-1 merged 5 commits intodevelopfrom
11733-api-get-file-citation-format
Apr 28, 2026
Merged

API: File Get Citation In Other Formats#12238
ChengShi-1 merged 5 commits intodevelopfrom
11733-api-get-file-citation-format

Conversation

@stevenwinship
Copy link
Copy Markdown
Contributor

What this PR does / why we need it: API needed for SPA

Which issue(s) this PR closes:#11733

Special notes for your reviewer:

Suggestions on how to test this:

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

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

Additional documentation: included

@stevenwinship stevenwinship self-assigned this Mar 20, 2026
@github-actions github-actions Bot added GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 10 Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA Type: Feature a feature request labels Mar 20, 2026
@stevenwinship stevenwinship moved this to In Progress 💻 in IQSS Dataverse Project Mar 20, 2026
@coveralls
Copy link
Copy Markdown

coveralls commented Mar 20, 2026

Coverage Status

coverage: 24.884% (-0.003%) from 24.887% — 11733-api-get-file-citation-format into develop

@github-actions

This comment has been minimized.

@stevenwinship stevenwinship removed their assignment Mar 20, 2026
@stevenwinship stevenwinship moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Mar 20, 2026
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@cmbz cmbz added the FY26 Sprint 20 FY26 Sprint 20 (2026-03-26 - 2026-04-08) label Mar 27, 2026
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@stevenwinship stevenwinship force-pushed the 11733-api-get-file-citation-format branch from b3b4b45 to f15cd9d Compare April 2, 2026 13:34
@github-actions

This comment has been minimized.

@stevenwinship stevenwinship force-pushed the 11733-api-get-file-citation-format branch from f15cd9d to efa910c Compare April 3, 2026 15:37
@github-actions

This comment has been minimized.

@cmbz cmbz added the FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) label Apr 8, 2026
@stevenwinship stevenwinship force-pushed the 11733-api-get-file-citation-format branch from efa910c to acbf825 Compare April 9, 2026 16:06
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@cmbz cmbz added the FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) label Apr 22, 2026
@sekmiller sekmiller self-assigned this Apr 23, 2026
@sekmiller sekmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Apr 23, 2026
@github-actions

This comment has been minimized.


Dataverse can generate datafile citations in "EndNote", "RIS", "BibTeX", and "CSL" formats.
This API call sends the raw format with the appropriate content-type (EndNote is XML, RIS and BibTeX are plain text, and CSL is JSON). ("Internal" is also a valid value, returning the content as HTML).
This API call requires a format in the API call which can be any of the values listed above.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is a little redundant. Can we just say "This API call requires a format which can be any of the values listed above."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not sure if you are asking to change the text or drop it?

Copy link
Copy Markdown
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.

I made a comment on the doc which you can choose to ignore.

@github-project-automation github-project-automation Bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Apr 23, 2026
@github-actions
Copy link
Copy Markdown

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11733-api-get-file-citation-format
ghcr.io/gdcc/configbaker:11733-api-get-file-citation-format

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

@ChengShi-1 ChengShi-1 moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Apr 28, 2026
@ChengShi-1 ChengShi-1 self-assigned this Apr 28, 2026
@ChengShi-1
Copy link
Copy Markdown
Contributor

I have done QA on different formats, they look good

@ChengShi-1 ChengShi-1 merged commit 7904e99 into develop Apr 28, 2026
21 checks passed
@github-project-automation github-project-automation Bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Apr 28, 2026
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Apr 29, 2026
@pdurbin pdurbin added this to the 6.11 milestone Apr 29, 2026
@stevenwinship stevenwinship deleted the 11733-api-get-file-citation-format branch April 30, 2026 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 20 FY26 Sprint 20 (2026-03-26 - 2026-04-08) FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 10 Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA Type: Feature a feature request

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

API: File Get Citation In Other Formats

7 participants