reorganize and fix typos

meilisearch · Aug 14, 2021 · a03b3a4 · a03b3a4
1 parent d11b654
commit a03b3a4
Showing 1 changed file with 12 additions and 8 deletions.
diff --git a/text/0061-error-format.md b/text/0061-error-format.md
@@ -9,26 +9,30 @@
 
 ### I. Summary
 
-The error format is updated to no longer contain unnecessary `error` prefix terms in the names of these attributes. The context is clear enough to understand that this is an `error` object.
+The error format is updated to no longer contain unnecessary `error` prefix terms in the names of these attributes. e.g. `errorType`. The context is clear enough to understand that this is an `error` object.
 
 #### Summary Key Points
 
-- `error` is removed from attributes name.
+- `error` is removed from the attributes name.
 
 ### II. Motivation
 
-The main motivation is to stabilize the current `error` resource to a version that conforms to our API convention and thus allow future evolutions on a more solid base. This specification avoids adding unnecessary information in the object's attribute names.
+The main motivation is to stabilize the current `error` resource to a version that conforms to our API convention and thus allows future evolutions on a more solid base. This specification avoids adding unnecessary information in the error object's attribute names.
 
 ### III. Explanation
 
-#### Error Format Definition
+#### Error Format
+
+##### Attributes
 
 | Field name | type   | Description                                                              |
 |------------|--------|--------------------------------------------------------------------------|
-| message    | string |  A human-readable message providing context and details about the error  |
-| code       | string |  An error code                                                           |
-| type       | string |  An error type for which the error code is linked                        |
-| link       | string |  An URL to the related error-page details                                |
+| message    | string |  A human-readable message providing context and details about the error. |
+| code       | string |  A short string indicating the error code reported.                      |
+| type       | string |  The type of error returned.                                             |
+| link       | string |  An URL to the related error-page details for further information.       |
+
+##### Json Response Example
 
 e.g. 401 Unauthorized Response example