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.

Sign up for GitHub

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

Jump to bottom

docs: file detection using first few bytes disabled on S3 direct upload #11035

Merged
merged 5 commits into from
Nov 19, 2024
+3 −1
Merged

docs: file detection using first few bytes disabled on S3 direct upload #11035

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
54677ce
file detection using first few bytes disabled on direct upload
pdurbin Nov 19, 2024
89b8a1c
Update doc/sphinx-guides/source/api/native-api.rst
landreev Nov 19, 2024
be0979d
Update doc/sphinx-guides/source/api/native-api.rst
landreev Nov 19, 2024
813063e
Update doc/sphinx-guides/source/developers/big-data-support.rst
landreev Nov 19, 2024
e5f8415
Update doc/sphinx-guides/source/api/native-api.rst
pdurbin Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/sphinx-guides/source/api/native-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3617,6 +3617,7 @@ The fully expanded example above (without environment variables) looks like this
Currently the following methods are used to detect file types:

- The file type detected by the browser (or sent via API).
- Custom code that reads the first few bytes. As explained at :ref:`s3-direct-upload-features-disabled`, this code is disabled during direct upload to S3. However, this code is active when the "redetect" API is used.
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree it's a good idea to spell this out in the guide; especially if it has been a source of confusion.
But, somewhat of a nitpick - I'm wondering if there's a better way to say this than "this code is disabled". Something along the lines of
"... this method of file type detection is not utilized during direct upload to S3, since by nature of direct upload Dataverse never sees the contents of the file."
Your call. I just feel like, technically, it is more like "does not apply" or "cannot be used" than "disabled".

Copy link
Contributor

Choose a reason for hiding this comment

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

Please also note that the above applies to the next line, JHOVE as well.

landreev marked this conversation as resolved.
Show resolved Hide resolved
- JHOVE: https://jhove.openpreservation.org
landreev marked this conversation as resolved.
Show resolved Hide resolved
- The file extension (e.g. ".ipybn") is used, defined in a file called ``MimeTypeDetectionByFileExtension.properties``.
- The file name (e.g. "Dockerfile") is used, defined in a file called ``MimeTypeDetectionByFileName.properties``.
Expand Down
1 change: 1 addition & 0 deletions doc/sphinx-guides/source/developers/big-data-support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Features that are Disabled if S3 Direct Upload is Enabled
The following features are disabled when S3 direct upload is enabled.

- Unzipping of zip files. (See :ref:`compressed-files`.)
- Detection of file type based on custom code that reads the first few bytes. (See :ref:`redetect-file-type`.)
landreev marked this conversation as resolved.
Show resolved Hide resolved
- Extraction of metadata from FITS files. (See :ref:`fits`.)
- Creation of NcML auxiliary files (See :ref:`netcdf-and-hdf5`.)
- Extraction of a geospatial bounding box from NetCDF and HDF5 files (see :ref:`netcdf-and-hdf5`) unless :ref:`dataverse.netcdf.geo-extract-s3-direct-upload` is set to true.
Expand Down
Loading