Skip to content
This repository was archived by the owner on Aug 5, 2021. It is now read-only.

Commit c04656b

Browse files
author
Kevin Richter
committed
Add TODOs
1 parent 0dbfac7 commit c04656b

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

source/v1/api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252

5353
ui.initOAuth({ clientId: 1 });
5454

55-
window.ui = ui
55+
window.ui = ui;
5656
}
5757
</script>
5858
</body>

source/v1/index.html.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -617,6 +617,10 @@ const job = await api.jobs.new({
617617
}).save();
618618
```
619619

620+
```php
621+
// TODO
622+
```
623+
620624
First a [`Job`](api/index.html#JobCreateRequest). A Job is a project on the Maps4News Platform.
621625

622626
<br/><br/><br/><br/>
@@ -628,6 +632,10 @@ const revision = await job.revisions.new({
628632
}).save(mapObject);
629633
```
630634

635+
```php
636+
// TODO
637+
```
638+
631639
Second a [`Job Revision`](api/index.html#JobRevisionCreateRequest). A Revision is a point-in-time that the user decided to save his/her current progress in designing their map.
632640

633641
A map object must be given to each revision. Revisions can not be updated, each save will result in a new revision.
@@ -640,6 +648,10 @@ Details about how to build a map object can be found on the [map object page](di
640648
await revision.build("http://example.com/callback");
641649
```
642650

651+
```php
652+
// TODO
653+
```
654+
643655
Lastly, we can queue a build of your map. This will create a `JobResult` resource for that revision.
644656

645657
<br/>
@@ -648,5 +660,9 @@ Lastly, we can queue a build of your map. This will create a `JobResult` resourc
648660
const result = await revision.result();
649661
```
650662

663+
```php
664+
// TODO
665+
```
666+
651667
You can access your result via the `result` method on your revision. Expect your result to be queued or processing if you get your result directly after queueing a build. It generally takes a few seconds to a few minutes to generate a map.
652668

0 commit comments

Comments
 (0)