File Create Or Update Request

This model is utilized where sets of files can be specified to be added or updated (e.g. PATCH:/dataset/{owner} and POST:/dataset/{owner}/{id}/files).

object

This model is utilized where sets of files can be specified to be added or updated (e.g. PATCH:/dataset/{owner} and POST:/dataset/{owner}/{id}/files).

description
string

File description.

maxLength: 240
minLength: 1
labels
array[string]

File labels.

Allowed Values: raw data, documentation, visualization, clean data, script, report
uniqueItems: true
name
string

File name. Should include type extension always when possible. Must not include slashes.

required
maxLength: 128
minLength: 1
pattern: ^[^/]+$
source
object

This model is utilized where source URLs can be specified for files to be added or updated.

authorization
object

An authorization type and credentials suitable for use in an HTTP Authorization header.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: <type> <credentials>

The credentials field is write-only. It is omitted by read operations.

credentials
object

A username and password suitable for use with HTTP Basic authentication.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: Basic <base64-encoding-of(user:password)>

The password field is write-only. It is omitted by read operations.

expandArchive
boolean

Indicates whether compressed files should be expanded upon upload.

1 validation
method
string
2 validations
oauthToken
object

A reference to a 3rd-party OAuth 2.0 token stored by data.world.

When creating or updating an OAuth token reference, the token must belong to the user making the update.

requestEntity
string
1 validation
requestHeaders
object

A map of custom HTTP header name/value pairs to pass with the request.

If a requestEntity string is specified, this must contain a Content-Type header.

An Authorization header value will be converted to a WebAuthorization object and the credentials will be encrypted.

The total size of the url and custom headers must not exceed 4096 bytes in the HTTP request, including whitespace, colons and CRLF characters.

url
string

Source URL of file. Must be an http, https, ftp, ftps or stream URL.

4 validations