@voxgig/sdkgen 1.3.1 → 1.3.4

package/project/.sdk/src/cmp/lua/ReadmeQuick_lua.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -14,8 +14,16 @@ const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
   const entity = getModelPath(model, `main.${KIT}.entity`)
 
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+
+  // Find a nested entity if available: one with a parent chain
+  // (relations.ancestors), an active load op, and a required non-id load
+  // param to demonstrate (the parent key, e.g. page_id).
   const nestedEntity = Object.values(entity).find((e: any) =>
-    e.active !== false && e.ancestors && e.ancestors.length > 0
+    e.active !== false &&
+    e.relations && e.relations.ancestors && 0 < e.relations.ancestors.length &&
+    entityOps(e).includes('load') &&
+    opRequestShape(e, 'load').items.some((it: any) =>
+      !it.optional && it.name !== entityIdField(e))
   ) as any
 
   const ctor = isAuthActive(model)
@@ -35,7 +43,7 @@ local client = ${ctor}
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
     const article = /^[aeiou]/i.test(eName) ? "an" : "a"
-    const opnames = Object.keys(exampleEntity.op || {})
+    const opnames = entityOps(exampleEntity)
     // Model-driven id key: `idF` is the MATCH key (null when none). `dataIdF`
     // is the id on the RETURNED record's data type — an entity can key its match
     // on an id it does not carry as data, so a record id read (`item["id"]`,
@@ -43,6 +51,20 @@ local client = ${ctor}
     const idF = entityIdField(exampleEntity)
     const dataIdF = entityDataIdField(exampleEntity)
 
+    // A type-correct, executable Lua literal for a param: numeric/boolean/
+    // table params render a typed literal; strings render the quoted
+    // placeholder (the doc test EXECUTES these blocks, so a comment
+    // placeholder would not parse). Non-identifier keys use bracket syntax.
+    const luaLit = (type: any, placeholder: string = 'example'): string => {
+      const k = canonKey(type)
+      if ('INTEGER' === k || 'NUMBER' === k) return '1'
+      if ('BOOLEAN' === k) return 'true'
+      if ('ARRAY' === k || 'OBJECT' === k) return '{}'
+      return `"${placeholder}"`
+    }
+    const luaKey = (name: string): string =>
+      /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+
     // MODEL-DRIVEN display field: the list example must reference a field
     // the entity actually has, not a hardcoded "name". Pick the entity's
     // first non-id string field (falling back to the first non-id field of
@@ -80,11 +102,56 @@ end
 `)
     }
 
-    if (opnames.includes('load')) {
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? "an" : "a"
+      const neVar = neName.toLowerCase()
+
+      // Model-driven match: every REQUIRED load-match key — the same shape
+      // the runtime resolves path params from, so the example always works.
+      // Parent keys (e.g. page_id) first, the entity's own id last.
+      const neIdF = entityIdField(nestedEntity)
+      const neRequired = opRequestShape(nestedEntity, 'load').items
+        .filter((it: any) => !it.optional)
+        .sort((a: any, b: any) =>
+          (a.name === neIdF ? 1 : 0) - (b.name === neIdF ? 1 : 0))
+      const parentItem = neRequired.find((it: any) => it.name !== neIdF) as any
+      const parentParam = parentItem && parentItem.name
+      const parentName = parentParam ? parentParam.replace(/_id$/, '') : 'its parent'
+      const neMatch = neRequired.map((it: any) =>
+        `${luaKey(it.name)} = ${luaLit(it.type,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)}`)
+
+      Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
+
+${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
+
+\`\`\`lua
+local ${neVar}, err = client:${neName}():load({ ${neMatch.join(', ')} })
+if err then error(err) end
+print(${neVar})
+\`\`\`
+
+`)
+    }
+    else if (opnames.includes('load')) {
+      // Every REQUIRED load-match key (id first, then parent path params like
+      // page_id) — the same shape the runtime resolves path params from, so
+      // the example always works.
+      const loadRequired = opRequestShape(exampleEntity, 'load').items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      const loadArg = 0 < loadRequired.length
+        ? `{ ${loadRequired.map((it: any) =>
+          `${luaKey(it.name)} = ${luaLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')} }`
+        : ''
+
       Content(`### 3. Load ${article} ${eName.toLowerCase()}
 
 \`\`\`lua
-local ${eName.toLowerCase()}, err = client:${eName}():load(${idF ? `{ ${idF} = "example_id" }` : ''})
+local ${eName.toLowerCase()}, err = client:${eName}():load(${loadArg})
 if err then error(err) end
 print(${eName.toLowerCase()})
 \`\`\`
@@ -95,24 +162,22 @@ print(${eName.toLowerCase()})
     // Model-driven example fields: derive the create/update body from the op
     // shape (opRequestShape) so the docs reference REAL writable fields, not a
     // hardcoded "name" the entity may not have. Literals are Lua-typed by the
-    // field's canonical type; non-identifier keys use bracket syntax.
-    const luaLit = (type: any): string => {
-      const k = canonKey(type)
-      if ('INTEGER' === k || 'NUMBER' === k) return '1'
-      if ('BOOLEAN' === k) return 'true'
-      if ('ARRAY' === k || 'OBJECT' === k) return '{}'
-      return '"example"'
-    }
-    const luaKey = (name: string): string =>
-      /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+    // field's canonical type; non-identifier keys use bracket syntax. ids are
+    // rendered separately as the match key for update/remove; a REQUIRED
+    // create id stays (the call is invalid without it).
     const examplePairs = (opname: string): string[] => {
       const items = opRequestShape(exampleEntity, opname).items
-        .filter((it: any) => !idNames.has(it.name))
+        .filter((it: any) => !idNames.has(it.name) ||
+          ('create' === opname && !it.optional))
       const required = items.filter((it: any) => !it.optional)
+      const optional = items.filter((it: any) => it.optional)
+      // create needs ALL required fields; update is a patch, so the required
+      // members plus a sample optional field or two suffice.
       const chosen = 'create' === opname
         ? (required.length ? required : items.slice(0, 2))
-        : items.slice(0, 2)
-      return chosen.map((it: any) => `${luaKey(it.name)} = ${luaLit(it.type)}`)
+        : required.concat(optional).slice(0, Math.max(2, required.length))
+      return chosen.map((it: any) =>
+        `${luaKey(it.name)} = ${luaLit(it.type, 'example_' + it.name)}`)
     }
 
     // The id VALUE for an update/remove match: off the returned `created` record
@@ -123,7 +188,7 @@ print(${eName.toLowerCase()})
     }
     const idValueFor = (opname: string): string => (null != dataIdF && opnames.includes('create'))
       ? `created["${dataIdF}"]`
-      : luaLit(idParamType(opname))
+      : luaLit(idParamType(opname), 'example_id')
 
     if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
       Content(`### 4. Create, update, and remove
@@ -145,8 +210,17 @@ client:${eName}():update({ ${updatePairs.join(', ')} })
 `)
       }
       if (opnames.includes('remove')) {
+        // Every REQUIRED remove-match key: the id (off the created record
+        // when possible) plus parent keys like page_id.
+        const removePairs = opRequestShape(exampleEntity, 'remove').items
+          .filter((it: any) => !it.optional || it.name === idF)
+          .sort((a: any, b: any) =>
+            (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+          .map((it: any) => it.name === idF
+            ? `${luaKey(it.name)} = ${idValueFor('remove')}`
+            : `${luaKey(it.name)} = ${luaLit(it.type, 'example_' + it.name)}`)
         Content(`-- Remove
-client:${eName}():remove(${idF ? `{ ${idF} = ${idValueFor('remove')} }` : ''})
+client:${eName}():remove(${removePairs.length ? `{ ${removePairs.join(', ')} }` : ''})
 `)
       }
       Content(`\`\`\`

package/project/.sdk/src/cmp/lua/ReadmeRef_lua.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, File, isAuthActive, entityIdField } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -7,6 +7,24 @@ import {
 } from '@voxgig/apidef'
 
 
+// A type-correct, executable Lua literal for a param: numeric/boolean/table
+// params render a typed literal; strings render the quoted placeholder (the
+// doc test EXECUTES runnable blocks, so a comment placeholder would not
+// parse).
+function luaLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '1'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k || 'OBJECT' === k) return '{}'
+  return `"${placeholder}"`
+}
+
+// Non-identifier table keys use bracket syntax.
+function luaKey(name: string): string {
+  return /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+}
+
+
 const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
   load: {
     sig: 'load(reqmatch, ctrl) -> any, err',
@@ -242,8 +260,20 @@ ${info.desc}
 
           // Show example
           if ('load' === opname || 'remove' === opname) {
+            // The id key plus every REQUIRED match key (parent path params
+            // like page_id) — the same shape the runtime resolves path
+            // params from, so the example always works.
+            const matchItems = opRequestShape(ent, opname).items
+              .filter((it: any) => !it.optional || it.name === idF)
+              .sort((a: any, b: any) =>
+                (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+            const arg = 0 < matchItems.length
+              ? `{ ${matchItems.map((it: any) =>
+                `${luaKey(it.name)} = ${luaLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)}`).join(', ')} }`
+              : ''
             Content(`\`\`\`lua
-local result, err = client:${ent.Name}():${opname}(${idF ? `{ ${idF} = "${ent.name}_id" }` : ''})
+local result, err = client:${ent.Name}():${opname}(${arg})
 \`\`\`
 
 `)
@@ -256,14 +286,19 @@ local results, err = client:${ent.Name}():list()
 `)
           }
           else if ('create' === opname) {
+            // Members come from the SAME shape the runtime validates
+            // (opRequestShape): every required member must appear — including
+            // a required id and parent keys like page_id (the --[[ type ]]
+            // placeholders mark the block as an illustration for the doc
+            // gate).
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
             Content(`\`\`\`lua
 local result, err = client:${ent.Name}():create({
 `)
-            each(fields, (field: any) => {
-              if ('id' !== field.name && field.req) {
-                Content(`  ${field.name} = --[[ ${canonToType(field.type, target.name)} ]],
+            createItems.map((it: any) => {
+              Content(`  ${luaKey(it.name)} = --[[ ${canonToType(it.type, target.name)} ]],
 `)
-              }
             })
             Content(`})
 \`\`\`
@@ -271,10 +306,18 @@ local result, err = client:${ent.Name}():create({
 `)
           }
           else if ('update' === opname) {
-            const updateIdLine = idF ? `  ${idF} = "${ent.name}_id",\n` : ''
+            // The id key plus every REQUIRED data member — the same shape the
+            // runtime validates — then the patch-fields note.
+            const updateItems = opRequestShape(ent, 'update').items
+              .filter((it: any) => !it.optional || it.name === idF)
+              .sort((a: any, b: any) =>
+                (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+            const updateLines = updateItems.map((it: any) =>
+              `  ${luaKey(it.name)} = ${luaLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)},\n`).join('')
             Content(`\`\`\`lua
 local result, err = client:${ent.Name}():update({
-${updateIdLine}  -- Fields to update
+${updateLines}  -- Fields to update
 })
 \`\`\`
 

package/project/.sdk/src/cmp/lua/ReadmeTopQuick_lua.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isAuthActive, envName, entityIdField } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -8,6 +8,23 @@ import {
 } from '@voxgig/apidef'
 
 
+// A type-correct, executable Lua literal for a param: numeric/boolean/table
+// params render a typed literal; strings render the quoted placeholder (the
+// doc test EXECUTES this block, so a comment placeholder would break it).
+function luaLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '1'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k || 'OBJECT' === k) return '{}'
+  return `"${placeholder}"`
+}
+
+// Non-identifier table keys use bracket syntax.
+function luaKey(name: string): string {
+  return /^[A-Za-z_]\w*$/.test(name) ? name : `["${name}"]`
+}
+
+
 const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
   const { target, ctx$: { model } } = props
 
@@ -45,9 +62,21 @@ print(${eName.toLowerCase()}s)
     }
 
     if (opnames.includes('load')) {
+      // Every REQUIRED load-match key (id first, then parent path params like
+      // page_id) — the same shape the runtime resolves path params from, so
+      // the example always works.
+      const loadItems = opRequestShape(exampleEntity, 'load').items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      const loadArg = 0 < loadItems.length
+        ? `{ ${loadItems.map((it: any) =>
+          `${luaKey(it.name)} = ${luaLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')} }`
+        : ''
       Content(`
 -- Load a specific ${eName.toLowerCase()}
-local ${eName.toLowerCase()}, err = client:${eName}():load(${idF ? `{ ${idF} = "example_id" }` : ''})
+local ${eName.toLowerCase()}, err = client:${eName}():load(${loadArg})
 print(${eName.toLowerCase()})
 `)
       hasCall = true

package/project/.sdk/src/cmp/lua/ReadmeTopTest_lua.ts

@@ -42,7 +42,16 @@ local client = sdk.test()
     const isMatchOp = 'load' === primaryOp || 'remove' === primaryOp
     let arg = ''
     if (isMatchOp) {
-      arg = idF ? `{ ${idF} = "test01" }` : ''
+      // Every REQUIRED match key (id first, then parent path params like
+      // page_id) — the same shape the runtime resolves path params from.
+      const items = opRequestShape(exampleEntity, primaryOp).items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      arg = 0 < items.length
+        ? `{ ${items.map((it: any) =>
+          `${luaKey(it.name)} = ${it.name === idF ? '"test01"' : luaLit(it.type)}`).join(', ')} }`
+        : ''
     } else if ('create' === primaryOp || 'update' === primaryOp) {
       const items = opRequestShape(exampleEntity, primaryOp).items
         .filter((it: any) => it.name !== idF && it.name !== 'id')
@@ -50,7 +59,9 @@ local client = sdk.test()
       const chosen = required.length ? required : items.slice(0, 3)
       arg = `{ ${chosen.map((it: any) => `${luaKey(it.name)} = ${luaLit(it.type)}`).join(', ')} }`
     }
-    Content(`local result, err = client:${eName}():${primaryOp}(${arg})
+    // A list result is an array — name the variable accordingly.
+    const rVar = 'list' === primaryOp ? 'results' : 'result'
+    Content(`local ${rVar}, err = client:${eName}():${primaryOp}(${arg})
 `)
   }
 

package/project/.sdk/src/cmp/php/Config_php.ts

@@ -10,6 +10,7 @@ import {
   cmp,
   each,
   isAuthActive,
+  resolveAuthPrefix,
 } from '@voxgig/sdkgen'
 
 
@@ -39,8 +40,8 @@ const Config = cmp(async function Config(props: any) {
   const headers = getModelPath(model, `main.${KIT}.config.headers`) || {}
 
   const authActive = isAuthActive(model)
-  let authPrefix = ''
-  try { authPrefix = getModelPath(model, `main.${KIT}.config.auth.prefix`) } catch (_e) { }
+  // config.auth.prefix override -> spec-derived info.security.prefix -> 'Bearer'
+  const authPrefix = resolveAuthPrefix(model)
 
   let baseUrl = ''
   try { baseUrl = getModelPath(model, `main.${KIT}.info.servers.0.url`) } catch (_e) { }

package/project/.sdk/src/cmp/php/ReadmeEntity_php.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, entityIdField } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -7,6 +7,19 @@ import {
 } from '@voxgig/apidef'
 
 
+// A type-correct, executable PHP literal for a param: numeric/boolean/array
+// params render a typed literal; strings render the quoted placeholder (the
+// doc test EXECUTES runnable blocks, so a comment placeholder would not
+// parse).
+function phpLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return '1'
+  if ('BOOLEAN' === k) return 'true'
+  if ('ARRAY' === k || 'OBJECT' === k) return '[]'
+  return `"${placeholder}"`
+}
+
+
 // Operation method spelling differs between Go and other languages — Go
 // uses PascalCase methods with explicit ctrl arg, others use lowercase
 // methods with optional ctrl. The op descriptions are language-agnostic.
@@ -95,11 +108,23 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
     }
 
     if (opnames.includes('load')) {
+      // The id key plus every REQUIRED match key (parent path params like
+      // page_id) — the same shape the runtime resolves path params from, so
+      // the example always works.
+      const loadItems = opRequestShape(entity, 'load').items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      const loadArg = 0 < loadItems.length
+        ? `[${loadItems.map((it: any) =>
+          `"${it.name}" => ${phpLit(it.type,
+            it.name === idF ? entity.name + '_id' : it.name)}`).join(', ')}]`
+        : ''
       Content(`#### Example: Load
 
 \`\`\`php
 // load() returns the bare ${entity.Name} record (throws on error).
-$${entity.name} = $client->${entity.Name}()->load(${idF ? `["${idF}" => "${entity.name}_id"]` : ''});
+$${entity.name} = $client->${entity.Name}()->load(${loadArg});
 \`\`\`
 
 `)
@@ -117,16 +142,19 @@ $${entity.name}s = $client->${entity.Name}()->list();
     }
 
     if (opnames.includes('create')) {
+      // Members come from the SAME shape the runtime validates
+      // (opRequestShape): every required member must appear — including a
+      // required id and parent keys like page_id.
+      const createItems = opRequestShape(entity, 'create').items
+        .filter((it: any) => !it.optional)
       Content(`#### Example: Create
 
 \`\`\`php
 $${entity.name} = $client->${entity.Name}()->create([
 `)
-      each(fields, (field: any) => {
-        if ('id' !== field.name && field.req) {
-          Content(`    "${field.name}" => null, // ${canonToType(field.type, target.name)}
+      createItems.map((it: any) => {
+        Content(`    "${it.name}" => null, // ${canonToType(it.type, target.name)}
 `)
-        }
       })
       Content(`]);
 \`\`\`

package/project/.sdk/src/cmp/php/ReadmeQuick_php.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -14,8 +14,16 @@ const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
   const entity = getModelPath(model, `main.${KIT}.entity`)
 
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+
+  // Find a nested entity if available: one with a parent chain
+  // (relations.ancestors), an active load op, and a required non-id load
+  // param to demonstrate (the parent key, e.g. page_id).
   const nestedEntity = Object.values(entity).find((e: any) =>
-    e.active !== false && e.ancestors && e.ancestors.length > 0
+    e.active !== false &&
+    e.relations && e.relations.ancestors && 0 < e.relations.ancestors.length &&
+    entityOps(e).includes('load') &&
+    opRequestShape(e, 'load').items.some((it: any) =>
+      !it.optional && it.name !== entityIdField(e))
   ) as any
 
   const ctor = isAuthActive(model)
@@ -36,7 +44,7 @@ $client = ${ctor};
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
     const article = /^[aeiou]/i.test(eName) ? "an" : "a"
-    const opnames = Object.keys(exampleEntity.op || {})
+    const opnames = entityOps(exampleEntity)
     // Model-driven id key: `idF` is the MATCH key (null when none). `dataIdF` is
     // the id on the RETURNED record's data type — an entity can key its match on
     // an id it does not carry as data, so `["id"]` off a returned record must be
@@ -44,6 +52,18 @@ $client = ${ctor};
     const idF = entityIdField(exampleEntity)
     const dataIdF = entityDataIdField(exampleEntity)
 
+    // A type-correct, executable PHP literal for a param: numeric/boolean/
+    // array params render a typed literal; strings render the quoted
+    // placeholder (the doc test EXECUTES these blocks, so a comment
+    // placeholder would not parse).
+    const phpLit = (type: any, placeholder: string = 'example'): string => {
+      const k = canonKey(type)
+      if ('INTEGER' === k || 'NUMBER' === k) return '1'
+      if ('BOOLEAN' === k) return 'true'
+      if ('ARRAY' === k || 'OBJECT' === k) return '[]'
+      return `"${placeholder}"`
+    }
+
     // Model-driven display field: the entity's first non-id string field
     // (falling back to any non-id field), so the list example prints a real
     // column instead of a hardcoded "name" the entity may not have.
@@ -74,13 +94,62 @@ try {
 `)
     }
 
-    if (opnames.includes('load')) {
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? "an" : "a"
+      const neVar = neName.toLowerCase()
+
+      // Model-driven match: every REQUIRED load-match key — the same shape
+      // the runtime resolves path params from, so the example always works.
+      // Parent keys (e.g. page_id) first, the entity's own id last.
+      const neIdF = entityIdField(nestedEntity)
+      const neRequired = opRequestShape(nestedEntity, 'load').items
+        .filter((it: any) => !it.optional)
+        .sort((a: any, b: any) =>
+          (a.name === neIdF ? 1 : 0) - (b.name === neIdF ? 1 : 0))
+      const parentItem = neRequired.find((it: any) => it.name !== neIdF) as any
+      const parentParam = parentItem && parentItem.name
+      const parentName = parentParam ? parentParam.replace(/_id$/, '') : 'its parent'
+      const neMatch = neRequired.map((it: any) =>
+        `"${it.name}" => ${phpLit(it.type,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)}`)
+
+      Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
+
+${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
+
+\`\`\`php
+try {
+    // load() returns the bare ${neName} record (throws on error).
+    $${neVar} = $client->${neName}()->load([${neMatch.join(', ')}]);
+    print_r($${neVar});
+} catch (\\Throwable $err) {
+    echo "Error: " . $err->getMessage();
+}
+\`\`\`
+
+`)
+    }
+    else if (opnames.includes('load')) {
+      // Every REQUIRED load-match key (id first, then parent path params like
+      // page_id) — the same shape the runtime resolves path params from, so
+      // the example always works.
+      const loadRequired = opRequestShape(exampleEntity, 'load').items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      const loadArg = 0 < loadRequired.length
+        ? `[${loadRequired.map((it: any) =>
+          `"${it.name}" => ${phpLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')}]`
+        : ''
+
       Content(`### 3. Load ${article} ${eName.toLowerCase()}
 
 \`\`\`php
 try {
     // load() returns the bare ${eName} record (throws on error).
-    $${eName.toLowerCase()} = $client->${eName}()->load(${idF ? `["${idF}" => "example_id"]` : ''});
+    $${eName.toLowerCase()} = $client->${eName}()->load(${loadArg});
     print_r($${eName.toLowerCase()});
 } catch (\\Throwable $err) {
     echo "Error: " . $err->getMessage();
@@ -93,23 +162,21 @@ try {
     // Model-driven example fields: derive the create/update body from the op
     // shape (opRequestShape) so the docs reference REAL writable fields, not a
     // hardcoded "name" the entity may not have. Literals are PHP-typed by the
-    // field's canonical type.
-    const idField = (exampleEntity.id && exampleEntity.id.field) || 'id'
-    const phpLit = (type: any): string => {
-      const k = canonKey(type)
-      if ('INTEGER' === k || 'NUMBER' === k) return '1'
-      if ('BOOLEAN' === k) return 'true'
-      if ('ARRAY' === k || 'OBJECT' === k) return '[]'
-      return '"example"'
-    }
+    // field's canonical type. ids are rendered separately as the match key for
+    // update/remove; a REQUIRED create id stays (the call is invalid without
+    // it).
     const examplePairs = (opname: string): string[] => {
       const items = opRequestShape(exampleEntity, opname).items
-        .filter((it: any) => it.name !== idField && it.name !== 'id')
+        .filter((it: any) => (it.name !== idF && it.name !== 'id') ||
+          ('create' === opname && !it.optional))
       const required = items.filter((it: any) => !it.optional)
+      const optional = items.filter((it: any) => it.optional)
+      // create needs ALL required fields; update is a patch, so the required
+      // members plus a sample optional field or two suffice.
       const chosen = 'create' === opname
         ? (required.length ? required : items.slice(0, 2))
-        : items.slice(0, 2)
-      return chosen.map((it: any) => `"${it.name}" => ${phpLit(it.type)}`)
+        : required.concat(optional).slice(0, Math.max(2, required.length))
+      return chosen.map((it: any) => `"${it.name}" => ${phpLit(it.type, 'example_' + it.name)}`)
     }
 
     // The id VALUE for an update/remove match: off the returned `$created`
@@ -121,7 +188,7 @@ try {
     }
     const idValueFor = (opname: string): string => (null != dataIdF && opnames.includes('create'))
       ? `$created["${dataIdF}"]`
-      : phpLit(idParamType(opname))
+      : phpLit(idParamType(opname), 'example_id')
 
     if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
       Content(`### 4. Create, update, and remove
@@ -143,8 +210,17 @@ $client->${eName}()->update([${updatePairs.join(', ')}]);
 `)
       }
       if (opnames.includes('remove')) {
+        // Every REQUIRED remove-match key: the id (off the created record
+        // when possible) plus parent keys like page_id.
+        const removePairs = opRequestShape(exampleEntity, 'remove').items
+          .filter((it: any) => !it.optional || it.name === idF)
+          .sort((a: any, b: any) =>
+            (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+          .map((it: any) => it.name === idF
+            ? `"${it.name}" => ${idValueFor('remove')}`
+            : `"${it.name}" => ${phpLit(it.type, 'example_' + it.name)}`)
         Content(`// Remove
-$client->${eName}()->remove(${idF ? `["${idF}" => ${idValueFor('remove')}]` : ''});
+$client->${eName}()->remove(${removePairs.length ? `[${removePairs.join(', ')}]` : ''});
 `)
       }
       Content(`\`\`\`