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

Handle Batch Errors #239

Open
donaldgray opened this issue Jan 17, 2025 · 0 comments
Open

Handle Batch Errors #239

donaldgray opened this issue Jan 17, 2025 · 0 comments
Labels
refined Identify refined tickets in backlog

Comments

@donaldgray
Copy link
Member

donaldgray commented Jan 17, 2025

Warning

Blocked by dlcs/protagonist#936

This ticket outlines what happens if a batch encounters an error. The overall process is:

  • Continue to process the manifest and save it to S3,
  • Requests for the public or API version of the manifest should return a 200 as we generated the manifest.
  • For API responses the "error" property of assets will outline which assets encountered failed.
  • The IIIF manifest will carry a "seeAlso" block to highlight any errors

dlcs/protagonist#936 adds a "seeAlso" error to any canvases that contain an erroring asset. We need to ensure that the error survives any canvas manipulation and ends up on:

  • The "canvas" element, if it's 1 image per canvas
  • OR the content resource if it's multiple images per canvas (e.g. a choice, sample json below):
"items": [
    {
      "id": "..canvas..",
      "type": "Canvas",
      "items": [
        {
          "id": "..annopage..",
          "type": "AnnotationPage",
          "items": [
            {
              "id": "..anno..",
              "type": "Annotation",
              "motivation": "painting",
              "body": {
                "type": "Choice",
                "items": [
                  {
                    "id": "../iiif-img/1/2/image-with-error/.../default.jpg",
                    "type": "Image",
                    "format": "image/jpeg",
                    "service": [...],
                    "seeAlso": "**error-from-nq**"
                  },
                  {
                    "id": "../iiif-img/1/2/image-without-error/.../default.jpg",
                    "type": "Image",
                    "format": "image/jpeg",
                    "service": [...]
                 }
            }
        }
   }
]

NQs in any deployed environment will need to be updated with new NQ configuration - this will need to be highlighted in release notes somehow. The example NQ in readme.md should be updated too.

@donaldgray donaldgray changed the title Handle Batch Errors **Unrefinable** Handle Batch Errors **Unrefined** Jan 23, 2025
@donaldgray donaldgray changed the title Handle Batch Errors **Unrefined** Handle Batch Errors Jan 24, 2025
@donaldgray donaldgray added the refined Identify refined tickets in backlog label Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refined Identify refined tickets in backlog
Projects
None yet
Development

No branches or pull requests

1 participant