-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a397b7d
commit 4fcb749
Showing
67 changed files
with
7,336 additions
and
3,827 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -158,13 +158,49 @@ Success | |
|
||
|
||
<details> | ||
<summary><i> Example:</i></summary> | ||
<summary><i> Examples:</i></summary> | ||
|
||
```json | ||
|
||
<details> | ||
<summary><i> success</i></summary> | ||
|
||
```json | ||
{ | ||
"value": { | ||
"success": true, | ||
"_id": "xxxxxxxxxxxxxxxxxxxxxx", | ||
"file_name": "shirt.png", | ||
"file_path": "/path/qwertyuiop-shirt.png", | ||
"content_type": "image/png", | ||
"namespace": "products-item-images", | ||
"operation": "putObject", | ||
"company_id": 2, | ||
"tags": [ | ||
"clothing", | ||
"shirt" | ||
], | ||
"size": 9999, | ||
"cdn": { | ||
"url": "https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png", | ||
"absolute_url": "https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png", | ||
"relative_url": "products/pictures/free/original/qwertyuiop-shirt.png" | ||
}, | ||
"upload": { | ||
"expiry": 5000, | ||
"url": "https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read" | ||
}, | ||
"created_on": "2020-02-03T09:50:04.240Z", | ||
"modified_on": "2020-02-03T09:50:04.240Z", | ||
"created_by": { | ||
"username": "[email protected]" | ||
} | ||
} | ||
} | ||
``` | ||
</details> | ||
|
||
</details> | ||
|
||
|
||
|
||
|
||
|
@@ -213,13 +249,29 @@ Success | |
|
||
|
||
<details> | ||
<summary><i> Example:</i></summary> | ||
<summary><i> Examples:</i></summary> | ||
|
||
```json | ||
|
||
<details> | ||
<summary><i> success</i></summary> | ||
|
||
```json | ||
{ | ||
"value": { | ||
"urls": [ | ||
{ | ||
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/documents/manifest/PDFs/test/s3EtYk5p9-new_fee.pdf", | ||
"signed_url": "https://fynd-staging-assets-private.s3-accelerate.amazonaws.com/addsale/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/documents/manifest/PDFs/test/s3EtYk5p9-new_fee.pdf", | ||
"expiry": 1800 | ||
} | ||
] | ||
} | ||
} | ||
``` | ||
</details> | ||
|
||
</details> | ||
|
||
|
||
|
||
|
||
|
@@ -283,19 +335,48 @@ This operation will return the URL of the uploaded file. | |
|
||
[StartResponse](#StartResponse) | ||
|
||
Success. Next, call the `completeUpload` API and pass the response payload of this API to finish the upload process. | ||
Success. Returns a response containing relaving and absolute_url of storage service | ||
|
||
|
||
|
||
|
||
<details> | ||
<summary><i> Example:</i></summary> | ||
<summary><i> Examples:</i></summary> | ||
|
||
```json | ||
|
||
<details> | ||
<summary><i> success</i></summary> | ||
|
||
```json | ||
{ | ||
"value": { | ||
"file_name": "shirt.png", | ||
"file_path": "/path/qwertyuiop-shirt.png", | ||
"content_type": "image/png", | ||
"method": "PUT", | ||
"namespace": "products-item-images", | ||
"operation": "putObject", | ||
"tags": [ | ||
"clothing", | ||
"shirt" | ||
], | ||
"size": 9999, | ||
"cdn": { | ||
"url": "https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png", | ||
"absolute_url": "https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png", | ||
"relative_url": "products/pictures/free/original/qwertyuiop-shirt.png" | ||
}, | ||
"upload": { | ||
"expiry": 5000, | ||
"url": "https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read" | ||
} | ||
} | ||
} | ||
``` | ||
</details> | ||
|
||
</details> | ||
|
||
|
||
|
||
|
||
|
@@ -329,6 +410,7 @@ Success. Next, call the `completeUpload` API and pass the response payload of th | |
| _id | string | no | | | ||
| cdn | [CDN](#CDN) | no | | | ||
| content_type | string | no | | | ||
| created_by | [CreatedBy](#CreatedBy)? | yes | | | ||
| created_on | string | no | | | ||
| file_name | string | no | | | ||
| file_path | string | no | | | ||
|
@@ -343,11 +425,20 @@ Success. Next, call the `completeUpload` API and pass the response payload of th | |
|
||
--- | ||
|
||
#### [FailedResponse](#FailedResponse) | ||
#### [CreatedBy](#CreatedBy) | ||
|
||
| Properties | Type | Nullable | Description | | ||
| ---------- | ---- | -------- | ----------- | | ||
| username | string? | yes | | | ||
|
||
|
||
--- | ||
|
||
#### [Params](#Params) | ||
|
||
| Properties | Type | Nullable | Description | | ||
| ---------- | ---- | -------- | ----------- | | ||
| message | string | no | | | ||
| subpath | string? | yes | The subpath for the file. | | ||
|
||
|
||
--- | ||
|
@@ -377,7 +468,7 @@ Success. Next, call the `completeUpload` API and pass the response payload of th | |
| ---------- | ---- | -------- | ----------- | | ||
| content_type | string | no | | | ||
| file_name | string | no | | | ||
| params | string? | yes | | | ||
| params | [Params](#Params)? | yes | | | ||
| size | number | no | | | ||
| tags | [string]? | yes | | | ||
|
||
|
Oops, something went wrong.