Skip to content

S3 file adapter docs missing parameters #5386

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.

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

Closed
mtrezza opened this issue Feb 22, 2019 · 2 comments
Closed

S3 file adapter docs missing parameters #5386

mtrezza opened this issue Feb 22, 2019 · 2 comments

Comments

@mtrezza
Copy link
Member

mtrezza commented Feb 22, 2019

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?

@acinader
Copy link
Contributor

would you be willing to open a pull request for this change?

@mtrezza
Copy link
Member Author

mtrezza commented Mar 10, 2019

PR merged

@mtrezza mtrezza closed this as completed Mar 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants