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

Export API: warn when omitting works from full publisher-metadata record #276

Open
rhigman opened this issue Aug 27, 2021 · 3 comments
Open
Labels
bug Something isn't working enhancement Improvement request feature/output Metadata output

Comments

@rhigman
Copy link
Member

rhigman commented Aug 27, 2021

If a user requests the metadata record for a work in a certain format and the work is missing a required field for that format (e.g. PDF publication URL for ONIX, Landing Page or Publication Date for KBART), an error message will be returned.

However, if a user requests the metadata record for all works by a given publisher, and one or more of these works are missing a required field, a record will be successfully returned with these works silently omitted.

Ideally, when we return a full publisher-metadata record, we should also return a list of which works were omitted, and what data was missing that resulted in them being omitted, so that the user is not unknowingly submitting incomplete lists of works to other platforms.

Relatedly, if every work by a given publisher is missing a required field, an empty publisher-metadata record will be returned, but with no error message or other warning.

@rhigman rhigman added enhancement Improvement request feature/output Metadata output bug Something isn't working labels Aug 27, 2021
@rhigman
Copy link
Member Author

rhigman commented Jan 5, 2022

#325 introduces another route by which a silently empty publisher-metadata record may be returned: if all of a publisher's records are Chapters.

@ja573
Copy link
Member

ja573 commented Feb 16, 2022

There might be situations in which a publisher may want to get the output as it is, but it'd be better if the default behaviour was to output the error if any book has errors. Maybe we could have a flag (e.g. permissive, strict, or dry-run) to toggle its permissiveness

@rhigman
Copy link
Member Author

rhigman commented Dec 20, 2023

There are also cases where hitting an error within a work breaks the ONIX formatting of the full publisher record, if a partial record has already been written to the stream when the error is encountered (e.g. missing USD price for Overdrive, which is not checked before the record writing begins, unlike e.g. missing publication date).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement Improvement request feature/output Metadata output
Projects
None yet
Development

No branches or pull requests

2 participants