Skip to content

Commit

Permalink
Add bit of a README.
Browse files Browse the repository at this point in the history
  • Loading branch information
adam-vessey committed Sep 19, 2024
1 parent 9c2b738 commit 6106fde
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions modules/foxml_file_validation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# FOXML File Validation

## Introduction

In migrations, we provide URIs in the `foxml://` scheme which do not have
meaningful file extensions, such as:

- `foxml://object/some:pid`; or,
- `foxml://datastream/some:pid+DSID+DSID.0`

Given these are served from a dedicated endpoint and the usual extension
validation does not have anything meaningful to work with, this module wraps
the base `FileExtension` validation such that it is bypassed when the `uri` of
the underlying file entity has the `foxml://` scheme. File _not_ in the
`foxml://` scheme should continue to validate extensions unchanged.

## Installation

Enable the (sub)module.

## Configuration

None.

0 comments on commit 6106fde

Please sign in to comment.