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

Tdrd 475 document the backend flow of metadata upload #204

Merged

Conversation

ian-hoyle
Copy link
Contributor

@ian-hoyle ian-hoyle commented Oct 7, 2024

Also added an ADR to detail CSV file integrity validation

Copy link
Contributor

@TomJKing TomJKing left a comment

Choose a reason for hiding this comment

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

Thanks for documenting this. Some comments on the ADR.

In addition can you add the diagram to this MD document as per the othe diagrams, with a brief explanation of the it: https://github.com/nationalarchives/tdr-dev-documentation/blob/master/beta-architecture/beta-architecture.md

@@ -0,0 +1,31 @@
# 35. Metadata CSV Validation
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you make this specific to the UTF-8 validation only.


## Structure and integrity checks

1. **Virus check**: All files uploaded to TDR are checked for viruses using the virus check lambda
Copy link
Contributor

Choose a reason for hiding this comment

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

Don't need to mention the virus check as this is only about the UTF-8 validation

@@ -82,3 +82,8 @@ The reference generator service will be used to assign citeable references.
for this to be a developer task, even though eventually we might build an
admin UI or integrate with the planned catalogue API
* Data stored in the export bucket can be transferred to the preservation system

## Metadata Validation
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for adding this

Copy link
Contributor

@TomJKing TomJKing left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks

@ian-hoyle ian-hoyle merged commit 3eb1891 into master Oct 24, 2024
2 checks passed
@ian-hoyle ian-hoyle deleted the TDRD-475-Document-the-backend-flow-of-Metadata-Upload branch October 24, 2024 09:35
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.

2 participants