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

Commit 9222f77

Browse files
committed
Typos, updates to the example
1 parent 1c8bd89 commit 9222f77

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

source/v1/index.html.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ To Log in and try it out hit the "Try out" button.
138138
{
139139
"success": false,
140140
"error": {
141-
"type": "HttpNotFoundException",
142-
"message": "Page Not Found",
141+
"type": "ValidationException",
142+
"message": "Input data failed to pass validation",
143143
"validation_errors": {
144144
"attribute": "validation error for the attribute"
145145
}
@@ -152,7 +152,7 @@ All JSON responses from the API is wrapped in a base object.
152152
Be sure to include an `Accept: application/json` header, otherwise errors like `401`, `403` & `404` will either return HTML or redirect you to the login page.
153153

154154
<aside class="warning">
155-
The current version (1.4.2) returns `validation_errors` as an array of string, this behavior will change the one described on the right in the next version 1.4.3. (no release ETA)
155+
The current version (1.4.2) returns `validation_errors` as an array of strings, this behavior will change the one described on the right in the next version 1.4.3. (no release ETA)
156156
</aside>
157157

158158

@@ -170,7 +170,7 @@ See [pagination](#pagination)
170170
- `X-Paginate-Pages`
171171
- `X-Paginate-Offset`
172172

173-
### For HTTP Caching we Expose
173+
### For HTTP Caching
174174

175175
- `Cache-Control`
176176
- `Last-Modified`
@@ -194,7 +194,7 @@ Because the ETags are weak they can also be used on other routes.
194194

195195
For example, when getting a resource the API will return a `ETag` header, the value of the `ETag` header can be used on the update route prevent [the lost update problem](https://www.morpheusdata.com/blog/2015-02-21-lost-update-db).
196196

197-
### We Also Expose CORS Headers
197+
### Exposed CORS Headers
198198

199199
- `Access-Control-Allow-Origin` (default `*`)
200200
- `Access-Control-Allow-Methods`
@@ -790,23 +790,28 @@ echo $previewResponse->getBody();
790790

791791
<br/>
792792

793-
- 1. Firstly we are gonna create a [`Job`](api/index.html#JobCreateRequest) instance. A Job is a project on the Maps4News Platform.<br/>
793+
- 1. Firstly we are gonna create a `Job` instance. A Job is a project on the Maps4News platform.<br/>
794794
We're gonna create an Annotation Map (`job_type_id`) which is a normal map with icons on it, and we're also giving out our map a title.
795795

796796
<br/>
797797

798-
- 2. 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.<br/>
799-
The Revision requires us to give it a `language_code`, these are 3 character string (eng, ger, ita, dut, etc.) as well a `mapstyle_set_id` and the map json as a string.<br/><br/>
800-
A map object must be given to each revision. Revisions can not be updated, each save will result in a new revision.<br/>
801-
Details about how to build a map object can be found on the [map object page](dispatcher.html).
798+
- 2. Second a `Job Revision`. A Revision is a point-in-time that the user decided to save his/her current progress in designing their map.
799+
800+
A `Revision` requires us to give it a `language_code`, these are 3 character strings, (eng, ger, ita, dut, etc.) as well a `mapstyle_set_id` and the map json as a string.
801+
802+
(A list of available mapstyle sets can be gotten from `/users/me/mapstyle-sets`)
803+
804+
A map object must be given to each revision. Revisions can not be updated, each save will result in a new revision.
805+
806+
Details about how to make a map object can be found on the [map object page](dispatcher.html).
802807

803808
<br/>
804809

805810
- 3. If your map object was valid and the revision was created we can queue a build of your map. This will create a `JobResult` resource for that revision.
806811

807812
<br/>
808813

809-
- 4. You can access your result via the `result` method on your revision.<br/>
814+
- 4. You can access your result via the `result` method on the revision.<br/>
810815
Expect your result to be queued or processing if you get your result directly after queueing a build.<br/>
811816
It generally takes a few seconds to a few minutes to generate a map.
812817

0 commit comments

Comments
 (0)