Skip to content

global: document metadata dumps /api/exporter endpoint#66

Merged
slint merged 1 commit into
zenodo:masterfrom
slint:metadata-dumps
Sep 25, 2025
Merged

global: document metadata dumps /api/exporter endpoint#66
slint merged 1 commit into
zenodo:masterfrom
slint:metadata-dumps

Conversation

@slint
Copy link
Copy Markdown
Member

@slint slint commented Sep 25, 2025 •
edited
Loading

CleanShot 2025-09-25 at 13 52 29@2x CleanShot 2025-09-25 at 13 52 54@2x CleanShot 2025-09-25 at 13 53 03@2x

@slint slint moved this to In review 🔍 in Sprint Q2 2026 ☀️ Sep 25, 2025
@carlinmack
Copy link
Copy Markdown
Contributor

carlinmack commented Sep 25, 2025

can the API still be changed? I feel like is_head should be is_latest

@slint
Copy link
Copy Markdown
Member Author

slint commented Sep 25, 2025 •
edited
Loading

can the API still be changed? I feel like is_head should be is_latest

I would say yes, since there are basically only 2-3 users that know about it (and I'm not sure if they care about the payload). We could add is_latest and "deprecate" the old field and communicate this to them.

ptamarit
ptamarit reviewed Sep 25, 2025
View reviewed changes
Comment thread source/includes/metadata-dumps/_root.md
| `removal_date` | Date the record was removed |
| `citation_text` | Citation text (if available) |

## Streaming processing example
Copy link
Copy Markdown
Member

@ptamarit ptamarit Sep 25, 2025

Choose a reason for hiding this comment

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

Nice idea to include an example!

@slint slint merged commit ecfa228 into zenodo:master Sep 25, 2025
1 check passed
@github-project-automation github-project-automation Bot moved this from In review 🔍 to To release 🤖 in Sprint Q2 2026 ☀️ Sep 25, 2025
@slint slint deleted the metadata-dumps branch September 25, 2025 12:35
@slint
Copy link
Copy Markdown
Member Author

slint commented Sep 25, 2025

can the API still be changed? I feel like is_head should be is_latest

I would say yes, since there are basically only 2-3 users that know about it (and I'm not sure if they care about the payload). We could add is_latest and "deprecate" the old field and communicate this to them.

This means code changes, so I wouldn't want a deployment to block publishing the docs for the existing functionality. I opened zenodo/zenodo-rdm#1251 for this (and possibly others)

@slint slint moved this from To release 🤖 to Released ✔️ in Sprint Q2 2026 ☀️ Sep 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ptamarit ptamarit ptamarit approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@slint @carlinmack @ptamarit