Describes a request to download an archive of a given repository at a specified commit, optionally filtered to only include certain paths.
Retrieves the format to create the archive in.
Retrieves a set of paths to filter the archive by.
Retrieves a prefix to apply to each entry in the archive.
Retrieves the format to create the archive in. The underlying SCM may support additional types, but every
SCM which supports archives is required to support every
Retrieves a set of paths to filter the archive by. The exact approach to filtering by path is SCM-specific, and SCM implementations are not required to support filtering if the underlying SCM doesn't.
Retrieves a prefix to apply to each entry in the archive. If a prefix is supplied, it will be prepended to all archived files and folders.
Since the most common use case for a prefix is to add a top-level folder to the archive, if the prefix
supplied did not end with a
/, one is added automatically. Otherwise, the prefix is not
considered a top-level directory; instead it modifies the file names. For example, consider a repository
containing the following files and folders:
A prefix of "example" would result in an archive containing:
While a prefix of "example/" would result in:
The prefix is normalized to add a trailing
/ to always produce the latter output.