@@ -86,10 +86,10 @@ You should specify those arguments [as per the documentation](https://kubernetes
8686
8787# APIs Specification
8888
89- # # Environment Settings
89+ # # Environment Settings
9090Before you get presigned url from S3, make sure the following environment variables have been set.
91- Variable | Description
92- --- | ---
91+ Variable | Description
92+ --- | ---
9393AWS_ACCESS_KEY_ID | The IMA user's access key id with full control permission to S3
9494AWS_Secret_Access_Key | The IMA user's secret access key
9595AWS_REGION | The AWS region, such as "us-east-1", "us-west-2"
@@ -100,10 +100,10 @@ AWS_S3_DEFAULT_BUCKET | optional, default bucket is applied if the bucket name i
100100```
101101GET /file/presigned?key=filepath[ &bucket=bucketname]
102102```
103- Note: The path variable :key doesn't allow the value is a path which includes '/' so that we change it from path variable to a query string
103+ Note: The path variable :key doesn't allow the value is a path which includes '/' so that we change it from path variable to a query string
104104### Parameters
105- Parameter | Description
106- --- | ---
105+ Parameter | Description
106+ --- | ---
107107key | The path+filename on the Bucket
108108bucket | The bucket name on S3. The default value will be applied if it isn't given.
109109
@@ -116,15 +116,15 @@ curl --location --request GET 'http://localhost:8090/file/presigned?key=images/w
116116curl --location --request GET 'http://localhost:8090/file/presigned/key=images/windows.png&bucket=bigfile-bucket '
117117```
118118### Response Body
119- Properties | Description
120- --- | ---
119+ Properties | Description
120+ --- | ---
121121url | The presigned url of uploading a file
122122method | The method of request to upload the file
123123
124124### Response Body Example
125125```
126126{
127- "url": "https://bigfile-bucket.s3.us-west-2.amazonaws.com/images/windows.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIIJ25ZBTRCYZHE4A %2F20201215%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20201215T180519Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=981aa47912512e7816b2e22ca70d8d541220dea549cb2f12f34006f6adf31af4 ",
127+ "url": "https://bigfile-bucket.s3.us-west-2.amazonaws.com/images/windows.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AK %2F20201215%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20201215T180519Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=1234 ",
128128 "method": "PUT"
129129}
130130```
@@ -135,7 +135,7 @@ curl --location --request PUT '[presigned url for update]' --header 'Content-Typ
135135```
136136#### Example
137137```
138- curl --location --request PUT 'https://bigfile-bucket.s3.us-west-2.amazonaws.com/images/windows.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIIJ25ZBTRCYZHE4A %2F20201215%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20201215T180519Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=981aa47912512e7816b2e22ca70d8d541220dea549cb2f12f34006f6adf31af4 ' \
138+ curl --location --request PUT 'https://bigfile-bucket.s3.us-west-2.amazonaws.com/images/windows.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AK %2F20201215%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20201215T180519Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=1234 ' \
139139--header 'Content-Type: text/plain' \
140140--data-binary '/user/work/hello.txt'
141141```
@@ -146,8 +146,8 @@ curl --location --request PUT 'https://bigfile-bucket.s3.us-west-2.amazonaws.com
146146GET /file?key=filepath[ &bucket=bucketname]
147147```
148148### Parameters
149- Parameter | Description
150- --- | ---
149+ Parameter | Description
150+ --- | ---
151151key | The path+filename on the Bucket
152152bucket | Optional, The bucket name on S3. The default value will be applied if it isn't given.
153153
@@ -160,15 +160,15 @@ curl --location --request GET 'http://localhost:8090/file?key=images/windows.png
160160curl --location --request GET 'http://localhost:8090/file?key=images/windows.png&bucket=bigfile-bucket'bucket=bigfile-bucket '
161161```
162162### Response Body
163- Properties | Description
164- --- | ---
163+ Properties | Description
164+ --- | ---
165165url | The presigned url of uploading a file
166166method | The method of request to upload the file
167167
168168### Response Body Example
169169```
170170{
171- "url": "https://bigfile-bucket.s3.us-west-2.amazonaws.com/images/windows.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIIJ25ZBTRCYZHE4A %2F20201215%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20201215T180519Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=981aa47912512e7816b2e22ca70d8d541220dea549cb2f12f34006f6adf31af4 ",
171+ "url": "https://bigfile-bucket.s3.us-west-2.amazonaws.com/images/windows.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AK %2F20201215%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20201215T180519Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=1234 ",
172172 "method": "GET"
173173}
174174```
@@ -177,7 +177,7 @@ method | The method of request to upload the file
177177Copy this presigned url and paste it into your browser, then done.
178178#### download through curl
179179```
180- curl --location --request GET '[ presigned url for download] '
180+ curl --location --request GET '[ presigned url for download] '
181181```
182182
183183# Database Migration
0 commit comments