Skip to content

Commit

Permalink
DocWorks for wix-media-manager-backend - 3 changes detected, but 1 is…
Browse files Browse the repository at this point in the history
…sue detected

changes:
Service wix-media-backend.MediaManager operation importFile has changed description
Service wix-media-backend.MediaManager operation upload has changed description
Service wix-media-backend.MediaManager message MetadataOptions member context has changed doc

issues:
Operation upload has an unknown param type Buffer (upload.js (1))
  • Loading branch information
sam-prais committed Jul 9, 2024
1 parent 1d90d12 commit 16cfe12
Showing 1 changed file with 7 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,8 @@
"extra":
{ } },
{ "name": "importFile",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "path",
Expand Down Expand Up @@ -725,7 +726,7 @@
" event is triggered when an imported file has been uploaded and before the transcoding is finished. As a result, some properties",
" such as the `fileUrl` may not initially appear in the returns. ",
"",
" >**Note:** Receiving a response does not indicate that the import is complete. To run code when the import finishes, implement the relevant [event](/wix-media-backend/events/introduction). See [Importing and Uploading Files](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/importing-and-uploading-files) to learn more." ],
" >**Note:** Receiving a response does not indicate that the import is complete. To run code when the import finishes, implement the relevant [event](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/introduction). See [Importing and Uploading Files](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/importing-and-uploading-files) to learn more." ],
"links": [],
"examples":
[ { "title": "Import a file",
Expand Down Expand Up @@ -1380,7 +1381,8 @@
"extra":
{ } },
{ "name": "upload",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "path",
Expand Down Expand Up @@ -1421,7 +1423,7 @@
"",
" >**Notes:** ",
" > - There are limits on the size and duration of files that you can upload. See [Wix Media: Supported Media File Types and File Sizes](https://support.wix.com/en/article/wix-media-supported-media-file-types-and-file-sizes) for more details.",
" > - Receiving a response does not indicate that the import is complete. To run code when the upload finishes, implement the relevant [event](/wix-media-backend/events/introduction). See [Importing and Uploading Files](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/importing-and-uploading-files) to learn more." ],
" > - Receiving a response does not indicate that the import is complete. To run code when the upload finishes, implement the relevant [event](/https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/introduction). See [Importing and Uploading Files](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/importing-and-uploading-files) to learn more." ],
"links": [],
"examples":
[ { "title": "Upload a file",
Expand Down Expand Up @@ -2178,7 +2180,7 @@
"optional": true },
{ "name": "context",
"type": "Object",
"doc": "An object of key:value string pairs containing information that is passed to the [`onFileUploaded()`](/wix-media-backend/events/on-file-uploaded), [`onAudioTranscoded()`](/wix-media-backend/events/on-audio-transcoded), or [`onVideoTranscoded()`](/wix-media-backend/events/on-video-transcoded) events. See [Importing and Uploading Files](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/importing-and-uploading-files) to learn more.\n back in the [`onFileUploaded()`](wix-media-backend.Events.html#onFileUploaded)\n event.",
"doc": "An object of key:value string pairs containing information that is passed to the [`onFileUploaded()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/on-file-uploaded), [`onAudioTranscoded()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/on-audio-transcoded), or [`onVideoTranscoded()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/on-video-transcoded) events. See [Importing and Uploading Files](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/importing-and-uploading-files) to learn more.\n back in the [`onFileUploaded()`](wix-media-backend.Events.html#onFileUploaded)\n event.",
"optional": true },
{ "name": "fileName",
"type": "string",
Expand Down

0 comments on commit 16cfe12

Please sign in to comment.