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

Download Single Authority file by id and format #505

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

elena-shmygaliova
Copy link

MDEXP-798 Authority download implementation as mrc file

Purpose

Expose a new endpoints in FOLIO to enable the downloading of the MARC file.
Endpoint should work in blocking sync mode and should not create an extra metadata for audit history and other needs as regular data import flow does with jobs. Endpoint should use default Job profiles for MARC authority download.

If utf=true is passed or no utf value is passed record is supposed to be returned in Unicode UTF-8 format. If utf=false is passed record is supposed to be returned in non-Unicode MARC-8 format.

Such endpoint execute next steps:

Fetches a record from mod-source-record-storage by id
Creates a MARC record in the given format from the retrieved record
Writes the generated content to a .mrc file and deliver it as a resource response
In case of error returns error message instead.

Approach

TODOS and Open Questions

Learning

Pre-Merge Checklist

Before merging this PR, please go through the following list and take appropriate actions.

  • Does this PR meet or exceed the expected quality standards?

    • Code coverage on new code is 80% or greater
    • Duplications on new code is 3% or less
    • Check logging
    • There are no major code smells or security issues
  • Does this introduce breaking changes?

    • Were any API paths or methods changed, added or removed?
    • Were there any schema changes?
    • Did any of the interface versions change?
    • Were permissions changed, added, or removed?
    • Are there new interface dependencies?
    • There are no breaking changes in this PR.

If there are breaking changes, please STOP and consider the following:

  • What other modules will these changes impact?
  • Do JIRAs exist to update the impacted modules?
    • If not, please create them
    • Do they contain the appropriate level of detail? Which endpoints/schemas changed, etc.
    • Do they have all they appropriate links to blocked/related issues?
  • Are the JIRAs under active development?
    • If not, contact the project's PO and make sure they're aware of the urgency.
  • Do PRs exist for these changes?
    • If so, have they been approved?

Ideally all of the PRs involved in breaking changes would be merged in the same day to avoid breaking the folio-testing environment. Communication is paramount if that is to be achieved, especially as the number of intermodule and inter-team dependencies increase.

While it's helpful for reviewers to help identify potential problems, ensuring that it's safe to merge is ultimately the responsibility of the PR assignee.

@elena-shmygaliova elena-shmygaliova force-pushed the MDEXP-798-Download-authority-as-marc branch 3 times, most recently from 26e14d1 to 8afbada Compare October 1, 2024 14:18
@elena-shmygaliova elena-shmygaliova requested a review from a team October 2, 2024 07:10
@elena-shmygaliova elena-shmygaliova force-pushed the MDEXP-798-Download-authority-as-marc branch from 058db46 to 8796ac0 Compare October 2, 2024 12:07
@elena-shmygaliova elena-shmygaliova force-pushed the MDEXP-798-Download-authority-as-marc branch 6 times, most recently from 9483643 to fa11de5 Compare October 2, 2024 16:03
@elena-shmygaliova elena-shmygaliova force-pushed the MDEXP-798-Download-authority-as-marc branch from fa11de5 to 74ea025 Compare October 2, 2024 16:04
Copy link

sonarcloud bot commented Oct 2, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants