Skip to content

S3 file adapter docs missing parameters #5386

Closed
@mtrezza

Description

@mtrezza

The S3 file adapter is missing some parameters that have been added over time.

Suggestions for parameters to add to doc:

baseUrl

  • Description: The base URL the file adapter uses to determine the file location for direct access.
  • Note: Optional. Default: null. To be used when directAccess=true. When set the file adapter returns a file URL in format baseUrl/bucketPrefix + filename. Example for baseUrl='http://domain.com/folder' and bucketPrefix='prefix_' the returned file location is http://domain.com/folder/prefix_file.txt.

baseUrlDirect

  • Description: Is true if the file adapter should ignore the bucket prefix when determining the file location for direct access.
  • Note: Optional. Default: false. To be used when directAccess=true and baseUrl is set. When set to true, the file adapter returns a file URL in format baseUrl/filename. Example for baseUrl='http://domain.com/folder' and baseUrlDirect=true the returned file location is http://domain.com/folder/file.txt.

globalCacheControl

  • Description: The Cache-Control http header to set in the file request.
  • Note: Optional. Default: null. Example: public, max-age=86400 for 24 hrs caching. More info here.

It seems worth to include the interplay of these parameters with the directAccess.

Found some references here:
https://github.com/parse-community/parse-server-s3-adapter
#1857
parse-community/parse-server-s3-adapter#13

Are the above parameter details understandable and correct?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions