Docs: mark errors prop required in the protocol

skryukov · skryukov · commit aadce4f872ee · 2025-04-10T22:45:15.000+03:00
inertiajs/inertiajs.com#369
diff --git a/docs/guide/the-protocol.md b/docs/guide/the-protocol.md
@@ -26,7 +26,7 @@ Content-Type: text/html; charset=utf-8
 </head>
 <body>
 
-<div id="app" data-page='{"component":"Event","props":{"event":{"id":80,"title":"Birthday party","start_date":"2019-06-02","description":"Come out and celebrate Jonathan&apos;s 36th birthday party!"}},"url":"/events/80","version":"c32b8e4965f418ad16eaebba1d4e960f"}'></div>
+<div id="app" data-page='{"component":"Event","props":{"errors":{},"event":{"id":80,"title":"Birthday party","start_date":"2019-06-02","description":"Come out and celebrate Jonathan&apos;s 36th birthday party!"}},"url":"/events/80","version":"c32b8e4965f418ad16eaebba1d4e960f"}'></div>
 
 </body>
 </html>
@@ -58,6 +58,7 @@ X-Inertia: true
 {
   "component": "Event",
   "props": {
+    "errors": {},
     "event": {
       "id": 80,
       "title": "Birthday party",
@@ -77,7 +78,7 @@ X-Inertia: true
 Inertia shares data between the server and client via a page object. This object includes the necessary information required to render the page component, update the browser's history state, and track the site's asset version. The page object includes the following four properties:
 
 1. `component`: The name of the JavaScript page component.
-2. `props`: The page props (data).
+2. `props`: The page props. Contains all of the page data along with an `errors` object (defaults to `{}` if there are no errors).
 3. `url`: The page URL.
 4. `version`: The current asset version.
 5. `encryptHistory`: Whether or not to encrypt the current page's history state.
@@ -141,7 +142,8 @@ Content-Type: application/json
   "props": {
     "auth": {...},       // NOT included
     "categories": [...], // NOT included
-    "events": [...]      // included
+    "events": [...],     // included
+    "errors": {}         // always included
   },
   "url": "/events/80",
   "version": "c32b8e4965f418ad16eaebba1d4e960f"
