Skip to content

Commit f6d1495

Browse files
makonimakoni
committed
docs updated
1 parent 86ce6e7 commit f6d1495

File tree

3 files changed

+63
-73
lines changed

3 files changed

+63
-73
lines changed

‎Documentation/REST API.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ let query = PaginationQuery()
4242
let filesList = uploadcare.list()
4343

4444
// Get file list
45-
filesList.get(withQuery: query) { (list, error) in
45+
filesList.get(withQuery: query) { list, error in
4646
if let error = error {
4747
print(error)
4848
return
@@ -58,7 +58,7 @@ Get next page:
5858
// Check if the next page is available
5959
guard filesList.next != nil else { return }
6060
// Get the next page
61-
filesList.nextPage { (list, error) in
61+
filesList.nextPage { list, error in
6262
if let error = error {
6363
print(error)
6464
return
@@ -73,7 +73,7 @@ Get previous page:
7373
// Check if the previous page is available
7474
guard filesList.previous != nil else { return }
7575
// Get the previous page
76-
filesList.previousPage { (list, error) in
76+
filesList.previousPage { list, error in
7777
if let error = error {
7878
print(error)
7979
return
@@ -85,7 +85,7 @@ filesList.previousPage { (list, error) in
8585
## File info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/fileInfo?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
8686

8787
```swift
88-
uploadcare.fileInfo(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, error) in
88+
uploadcare.fileInfo(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { file, error in
8989
if let error = error {
9090
print(error)
9191
return
@@ -99,7 +99,7 @@ uploadcare.fileInfo(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, e
9999
Store an individual file:
100100

101101
```swift
102-
uploadcare.storeFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, error) in
102+
uploadcare.storeFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { file, error in
103103
if let error = error {
104104
print(error)
105105
return
@@ -112,7 +112,7 @@ Batch file storing:
112112

113113
```swift
114114
let uuids = ["b7a301d1-1bd0-473d-8d32-708dd55addc0", "1bac376c-aa7e-4356-861b-dd2657b5bfd2"]
115-
uploadcare.storeFiles(withUUIDs: uuids) { (response, error) in
115+
uploadcare.storeFiles(withUUIDs: uuids) { response, error in
116116
if let error = error {
117117
print(error)
118118
return
@@ -126,7 +126,7 @@ uploadcare.storeFiles(withUUIDs: uuids) { (response, error) in
126126
Delete an individual file:
127127

128128
```swift
129-
uploadcare.deleteFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { (file, error) in
129+
uploadcare.deleteFile(withUUID: "1bac376c-aa7e-4356-861b-dd2657b5bfd2") { file, error in
130130
if let error = error {
131131
print(error)
132132
return
@@ -139,7 +139,7 @@ Batch file delete:
139139

140140
```swift
141141
let uuids = ["b7a301d1-1bd0-473d-8d32-708dd55addc0", "1bac376c-aa7e-4356-861b-dd2657b5bfd2"]
142-
uploadcare.deleteFiles(withUUIDs: uuids) { (response, error) in
142+
uploadcare.deleteFiles(withUUIDs: uuids) { response, error in
143143
if let error = error {
144144
print(error)
145145
return
@@ -151,7 +151,7 @@ uploadcare.deleteFiles(withUUIDs: uuids) { (response, error) in
151151
## Copy file to local storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/copyFileLocal?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
152152

153153
```swift
154-
uploadcare.copyFileToLocalStorage(source: "6ca619a8-70a7-4777-8de1-7d07739ebbd9") { (response, error) in
154+
uploadcare.copyFileToLocalStorage(source: "6ca619a8-70a7-4777-8de1-7d07739ebbd9") { response, error in
155155
if let error = error {
156156
print(error)
157157
return
@@ -164,7 +164,7 @@ uploadcare.copyFileToLocalStorage(source: "6ca619a8-70a7-4777-8de1-7d07739ebbd9"
164164

165165
```swift
166166
let source = "99c48392-46ab-4877-a6e1-e2557b011176"
167-
uploadcare.copyFileToRemoteStorage(source: source, target: "one_more_project", makePublic: true, pattern: .uuid) { (response, error) in
167+
uploadcare.copyFileToRemoteStorage(source: source, target: "one_more_project", makePublic: true, pattern: .uuid) { response, error in
168168
if let error = error {
169169
print(error)
170170
return
@@ -180,7 +180,7 @@ let query = GroupsListQuery()
180180
.limit(100)
181181
.ordering(.datetimeCreatedDESC)
182182

183-
uploadcare.listOfGroups(withQuery: query) { (list, error) in
183+
uploadcare.listOfGroups(withQuery: query) { list, error in
184184
if let error = error {
185185
print(error)
186186
return
@@ -191,7 +191,7 @@ uploadcare.listOfGroups(withQuery: query) { (list, error) in
191191
// Using a GroupsList object
192192
let groupsList = uploadcare.listOfGroups()
193193

194-
groupsList.get(withQuery: query) { (list, error) in
194+
groupsList.get(withQuery: query) { list, error in
195195
if let error = error {
196196
print(error)
197197
return
@@ -200,14 +200,14 @@ groupsList.get(withQuery: query) { (list, error) in
200200
}
201201

202202
// Get the next page
203-
groupsList.nextPage { (list, error) in
203+
groupsList.nextPage { list, error in
204204
if let error = error {
205205
print(error)
206206
return
207207
}
208208
}
209209
// Get the previous page
210-
groupsList.previousPage { (list, error) in
210+
groupsList.previousPage { list, error in
211211
if let error = error {
212212
print(error)
213213
return
@@ -219,7 +219,7 @@ groupsList.previousPage { (list, error) in
219219
## Group info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/groupInfo?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
220220

221221
```swift
222-
uploadcare.groupInfo(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (group, error) in
222+
uploadcare.groupInfo(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { group, error in
223223
if let error = error {
224224
print(error)
225225
return
@@ -231,7 +231,7 @@ uploadcare.groupInfo(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (grou
231231
## Store group ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Group/paths/~1groups~1%3Cuuid%3E~1storage~1/put?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
232232

233233
```swift
234-
uploadcare.storeGroup(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (error) in
234+
uploadcare.storeGroup(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { error in
235235
if let error = error {
236236
print(error)
237237
return
@@ -243,7 +243,7 @@ uploadcare.storeGroup(withUUID: "c5bec8c7-d4b6-4921-9e55-6edb027546bc~1") { (err
243243
## Project info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/projectInfo?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
244244

245245
```swift
246-
uploadcare.getProjectInfo { (project, error) in
246+
uploadcare.getProjectInfo { project, error in
247247
if let error = error {
248248
print(error)
249249
return
@@ -261,7 +261,7 @@ Example: https://yourdomain.com/{UUID}/ — backend redirects to https://cdn.you
261261

262262
```swift
263263
let url = URL(string: "https://yourdomain.com/FILE_UUID/")!
264-
uploadcare.getAuthenticatedUrlFromUrl(url, { (value, error) in
264+
uploadcare.getAuthenticatedUrlFromUrl(url) { value, error in
265265
if let error = error {
266266
print(error)
267267
return
@@ -275,7 +275,7 @@ uploadcare.getAuthenticatedUrlFromUrl(url, { (value, error) in
275275
## List of webhooks ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/webhooksList?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
276276

277277
```swift
278-
uploadcare.getListOfWebhooks { (value, error) in
278+
uploadcare.getListOfWebhooks { value, error in
279279
if let error = error {
280280
print(error)
281281
return
@@ -291,7 +291,7 @@ Create and subscribe to a webhook. You can use webhooks to receive notifications
291291

292292
```swift
293293
let url = URL(string: "https://yourwebhook.com")!
294-
uploadcare.createWebhook(targetUrl: url, isActive: true, signingSecret: "someSigningSecret") { (value, error) in
294+
uploadcare.createWebhook(targetUrl: url, isActive: true, signingSecret: "someSigningSecret") { value, error in
295295
if let error = error {
296296
print(error)
297297
return
@@ -307,7 +307,7 @@ Update webhook attributes.
307307

308308
```swift
309309
let url = URL(string: "https://yourwebhook.com")!
310-
uploadcare.updateWebhook(id: "webhookId", targetUrl: url, isActive: true, signingSecret: "someNewSigningSecret") { (value, error) in
310+
uploadcare.updateWebhook(id: "webhookId", targetUrl: url, isActive: true, signingSecret: "someNewSigningSecret") { value, error in
311311
if let error = error {
312312
print(error)
313313
return
@@ -323,7 +323,7 @@ Unsubscribe and delete a webhook.
323323

324324
```swift
325325
let url = URL(string: "https://yourwebhook.com")!
326-
uploadcare.deleteWebhook(forTargetUrl: url) { (error) in
326+
uploadcare.deleteWebhook(forTargetUrl: url) { error in
327327
if let error = error {
328328
print(error)
329329
}
@@ -340,7 +340,7 @@ let task1 = DocumentConversionJobSettings(forFile: file1)
340340
let task2 = DocumentConversionJobSettings(forFile: file2)
341341
.format(.pdf)
342342

343-
uploadcare.convertDocumentsWithSettings([task1, task2]) { (response, error) in
343+
uploadcare.convertDocumentsWithSettings([task1, task2]) { response, error in
344344
if let error = error {
345345
print(error)
346346
return
@@ -353,7 +353,7 @@ uploadcare.convertDocumentsWithSettings([task1, task2]) { (response, error) in
353353
Alternatively, you can pass custom "paths" param as array of strings (see ([documentation](https://uploadcare.com/docs/transformations/document_conversion/#convert-url-formatting?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift))):
354354

355355
```swift
356-
uploadcare.convertDocuments([":uuid/document/-/format/:target-format/"]) { (response, error) in
356+
uploadcare.convertDocuments([":uuid/document/-/format/:target-format/"]) { response, error in
357357
if let error = error {
358358
print(error)
359359
return
@@ -366,7 +366,7 @@ uploadcare.convertDocuments([":uuid/document/-/format/:target-format/"]) { (resp
366366
## Document conversion job status ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Conversion/paths/~1convert~1document~1status~1{token}~1/get?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
367367

368368
```swift
369-
uploadcare.documentConversionJobStatus(token: 123456) { (job, error) in
369+
uploadcare.documentConversionJobStatus(token: 123456) { job, error in
370370
if let error = error {
371371
print(error)
372372
return
@@ -399,7 +399,7 @@ let task2 = VideoConversionJobSettings(forFile: file2)
399399
.format(.mp4)
400400
.quality(.lightest)
401401

402-
uploadcare.convertVideosWithSettings([task1, task2]) { (response, error) in
402+
uploadcare.convertVideosWithSettings([task1, task2]) { response, error in
403403
if let error = error {
404404
print(error)
405405
return
@@ -412,7 +412,7 @@ uploadcare.convertVideosWithSettings([task1, task2]) { (response, error) in
412412
Alternatively, you can pass custom "paths" param as array of strings (see ([documentation](https://uploadcare.com/docs/transformations/video_encoding/#process-url-formatting?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift))):
413413

414414
```swift
415-
uploadcare.convertVideos([":uuid/video/-/format/ogg/"]) { (response, error) in
415+
uploadcare.convertVideos([":uuid/video/-/format/ogg/"]) { response, error in
416416
if let error = error {
417417
print(error)
418418
return
@@ -425,7 +425,7 @@ uploadcare.convertVideos([":uuid/video/-/format/ogg/"]) { (response, error) in
425425
## Video conversion job status ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/videoConvertStatus?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-swift)) ##
426426

427427
```swift
428-
uploadcare.videoConversionJobStatus(token: 123456) { (job, error) in
428+
uploadcare.videoConversionJobStatus(token: 123456) { job, error in
429429
if let error = error {
430430
print(error)
431431
return

0 commit comments

Comments
 (0)