try to explain the opaqueness of upload_params better

closes CNVS-37422

Change-Id: I3965d69e1382adc2f887ccc035777a2c3251bf65
Reviewed-on: https://gerrit.instructure.com/122181
Tested-by: Jenkins
Reviewed-by: Rob Orton <rob@instructure.com>
Product-Review: Cody Cutrer <cody@instructure.com>
QA-Review: Cody Cutrer <cody@instructure.com>
This commit is contained in:
Cody Cutrer 2017-08-09 12:57:16 -06:00
parent 3d81df8a0b
commit c3c8c10360
1 changed files with 2 additions and 13 deletions

View File

@ -58,12 +58,7 @@ Example Response:
"upload_url": "https://some-bucket.s3.amazonaws.com/",
"upload_params": {
"key": "/users/1234/files/profile_pic.jpg",
"acl": "private",
"Filename": "profile_pic.jpg",
"AWSAccessKeyId": "some_id",
"Policy": "some_opaque_string",
"Signature": "another_opaque_string",
"Content-Type": "image/jpeg"
<unspecified parameters; key above will not necesarily be present either>
}
}
```
@ -97,13 +92,7 @@ Example Request:
```bash
curl '<upload_url>' \
-F 'key=/users/1234/files/profile_pic.jpg' \
-F 'acl=private' \
-F 'Filename=profile_pic.jpg' \
-F 'AWSAccessKeyId=some_id' \
-F 'Policy=some_opaque_string' \
-F 'Signature=another_opaque_string' \
-F 'Content-Type=image/jpeg' \
-F '<any other fields returned in upload_params>' \
<any other parameters specified in the upload_params response>
-F 'file=@my_local_file.jpg'
```