@voxgig/sdkgen 1.2.1 → 1.3.2

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

@@ -1,12 +1,13 @@
 
-import { cmp, each, Content } from '@voxgig/sdkgen'
+import { cmp, each, Content, envName, isAuthActive } from '@voxgig/sdkgen'
 
 
 const ReadmeOptions = cmp(function ReadmeOptions(props: any) {
   const { target } = props
   const { model } = props.ctx$
 
-  const publishedOptions = each(target.options).filter((option: any) => option.publish)
+  const publishedOptions = each(target.options).filter((option: any) =>
+    option.publish && ('apikey' !== option.name || isAuthActive(model)))
   if (0 === publishedOptions.length) {
     return
   }
@@ -25,7 +26,7 @@ $client = new ${model.Name}SDK([
 
   publishedOptions.map((option: any) => {
     if ('apikey' === option.name) {
-      Content(`    "${option.name}" => getenv("${model.NAME}_APIKEY"),
+      Content(`    "${option.name}" => getenv("${envName(model)}_APIKEY"),
 `)
     }
     else {

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

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityDataIdField, entityOps } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -14,13 +14,21 @@ 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 apikeyArg = isAuthActive(model)
-    ? `\n    "apikey" => getenv("${model.NAME}_APIKEY"),\n`
-    : ''
+  const ctor = isAuthActive(model)
+    ? `new ${model.const.Name}SDK([\n    "apikey" => getenv("${envName(model)}_APIKEY"),\n])`
+    : `new ${model.const.Name}SDK()`
 
   Content(`### 1. Create a client
 
@@ -28,65 +36,191 @@ const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
 <?php
 require_once '${model.const.Name.toLowerCase()}_sdk.php';
 
-$client = new ${model.const.Name}SDK([${apikeyArg}]);
+$client = ${ctor};
 \`\`\`
 
 `)
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
-    const opnames = Object.keys(exampleEntity.op || {})
+    const article = /^[aeiou]/i.test(eName) ? "an" : "a"
+    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
+    // guarded on this, not the match key.
+    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.
+    const fields = exampleEntity.fields || []
+    const displayField =
+      fields.find((f: any) => f && f.name !== 'id' && f.type === '$STRING') ||
+      fields.find((f: any) => f && f.name !== 'id') ||
+      null
+    const idCol = dataIdF ? `$item[${JSON.stringify(dataIdF)}]` : null
+    const dispCol = displayField ? `$item[${JSON.stringify(displayField.name)}]` : null
+    const itemPrint = [idCol, dispCol].filter(Boolean).join(' . " " . ') || 'json_encode($item)'
 
     if (opnames.includes('list')) {
-      Content(`### 2. List ${eName.toLowerCase()}s
+      Content(`### 2. List ${eName.toLowerCase()} records
 
 \`\`\`php
-[$result, $err] = $client->${eName}(null)->list(null, null);
-if ($err) { throw new \\Exception($err); }
-
-if (is_array($result)) {
-    foreach ($result as $item) {
-        $d = $item->data_get();
-        echo $d["id"] . " " . $d["name"] . "\\n";
+try {
+    // list() returns an array of ${eName} records — iterate directly.
+    $${eName.toLowerCase()}s = $client->${eName}()->list();
+    foreach ($${eName.toLowerCase()}s as $item) {
+        echo ${itemPrint} . "\\n";
     }
+} catch (\\Throwable $err) {
+    echo "Error: " . $err->getMessage();
 }
 \`\`\`
 
 `)
     }
 
-    if (opnames.includes('load')) {
-      Content(`### 3. Load a ${eName.toLowerCase()}
+    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
-[$result, $err] = $client->${eName}(null)->load(["id" => "example_id"], null);
-if ($err) { throw new \\Exception($err); }
-print_r($result);
+try {
+    // load() returns the bare ${eName} record (throws on error).
+    $${eName.toLowerCase()} = $client->${eName}()->load(${loadArg});
+    print_r($${eName.toLowerCase()});
+} catch (\\Throwable $err) {
+    echo "Error: " . $err->getMessage();
+}
 \`\`\`
 
 `)
     }
 
+    // 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. 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 !== 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))
+        : 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`
+    // record only when its data type carries the id AND a create ran, else a
+    // type-correct literal.
+    const idParamType = (opname: string): any => {
+      const it = opRequestShape(exampleEntity, opname).items.find((x: any) => x.name === idF)
+      return it && it.type
+    }
+    const idValueFor = (opname: string): string => (null != dataIdF && opnames.includes('create'))
+      ? `$created["${dataIdF}"]`
+      : phpLit(idParamType(opname), 'example_id')
+
     if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
       Content(`### 4. Create, update, and remove
 
 \`\`\`php
 `)
       if (opnames.includes('create')) {
-        Content(`// Create
-[$created, $_] = $client->${eName}(null)->create(["name" => "Example"], null);
+        Content(`// create() returns the bare created ${eName} record.
+$created = $client->${eName}()->create([${examplePairs('create').join(', ')}]);
 
 `)
       }
       if (opnames.includes('update')) {
-        Content(`// Update
-$client->${eName}(null)->update(["id" => $created["id"], "name" => "Example-Renamed"], null);
+        const updatePairs = (idF ? [`"${idF}" => ${idValueFor('update')}`] : []).concat(examplePairs('update'))
+        const fromCreated = null != dataIdF && opnames.includes('create')
+        Content(`// Update${fromCreated ? ` — index the bare record directly ($created["${dataIdF}"]).` : ''}
+$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}(null)->remove(["id" => $created["id"]], null);
+$client->${eName}()->remove(${removePairs.length ? `[${removePairs.join(', ')}]` : ''});
 `)
       }
       Content(`\`\`\`

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

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, File, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -7,31 +7,44 @@ 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}"`
+}
+
+
 const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
   load: {
-    sig: 'load(array $reqmatch, ?array $ctrl = null): array',
-    returns: 'array [$result, $err]',
-    desc: 'Load a single entity matching the given criteria.',
+    sig: 'load(array $reqmatch, ?array $ctrl = null): mixed',
+    returns: 'mixed — the result data; throws on error',
+    desc: 'Load a single entity matching the given criteria. Throws on error.',
   },
   list: {
-    sig: 'list(array $reqmatch, ?array $ctrl = null): array',
-    returns: 'array [$result, $err]',
-    desc: 'List entities matching the given criteria. Returns an array.',
+    sig: 'list(?array $reqmatch = null, ?array $ctrl = null): mixed',
+    returns: 'array — the list of results; throws on error',
+    desc: 'List entities matching the given criteria (call with no argument to list all). Returns an array. Throws on error.',
   },
   create: {
-    sig: 'create(array $reqdata, ?array $ctrl = null): array',
-    returns: 'array [$result, $err]',
-    desc: 'Create a new entity with the given data.',
+    sig: 'create(array $reqdata, ?array $ctrl = null): mixed',
+    returns: 'mixed — the result data; throws on error',
+    desc: 'Create a new entity with the given data. Throws on error.',
   },
   update: {
-    sig: 'update(array $reqdata, ?array $ctrl = null): array',
-    returns: 'array [$result, $err]',
-    desc: 'Update an existing entity. The data must include the entity `id`.',
+    sig: 'update(array $reqdata, ?array $ctrl = null): mixed',
+    returns: 'mixed — the result data; throws on error',
+    desc: 'Update an existing entity. The data must include the entity `id`. Throws on error.',
   },
   remove: {
-    sig: 'remove(array $reqmatch, ?array $ctrl = null): array',
-    returns: 'array [$result, $err]',
-    desc: 'Remove the entity matching the given criteria.',
+    sig: 'remove(array $reqmatch, ?array $ctrl = null): mixed',
+    returns: 'mixed — the result data; throws on error',
+    desc: 'Remove the entity matching the given criteria. Throws on error.',
   },
 }
 
@@ -60,7 +73,7 @@ Complete API reference for the ${model.Name} ${target.title} SDK.
 `)
 
     Content(`\`\`\`php
-require_once __DIR__ . '/${model.name}_sdk.php';
+require_once __DIR__ . '/${model.const.Name.toLowerCase()}_sdk.php';
 
 $client = new ${model.const.Name}SDK($options);
 \`\`\`
@@ -72,8 +85,7 @@ Create a new SDK client instance.
 | Name | Type | Description |
 | --- | --- | --- |
 | \`$options\` | \`array\` | SDK configuration options. |
-| \`$options["apikey"]\` | \`string\` | API key for authentication. |
-| \`$options["base"]\` | \`string\` | Base URL for API requests. |
+${isAuthActive(model) ? '| \`$options["apikey"]\` | \`string\` | API key for authentication. |\n' : ''}| \`$options["base"]\` | \`string\` | Base URL for API requests. |
 | \`$options["prefix"]\` | \`string\` | URL prefix appended after base. |
 | \`$options["suffix"]\` | \`string\` | URL suffix appended after path. |
 | \`$options["headers"]\` | \`array\` | Custom headers for all requests. |
@@ -115,17 +127,20 @@ Create a new \`${ent.Name}Entity\` instance. Pass \`null\` for no initial data.
     })
 
 
-    Content(`#### \`optionsMap(): array\`
+    Content(`#### \`options_map(): array\`
 
 Return a deep copy of the current SDK options.
 
-#### \`getUtility(): ProjectNameUtility\`
+#### \`get_utility(): ${model.const.Name}Utility\`
 
 Return a copy of the SDK utility object.
 
 #### \`direct(array $fetchargs = []): array\`
 
-Make a direct HTTP request to any API endpoint. Returns \`[$result, $err]\`.
+Make a direct HTTP request to any API endpoint. This is the raw-HTTP escape
+hatch: it does **not** throw. It returns a result array
+\`["ok" => bool, "status" => int, "headers" => array, "data" => mixed]\`, or
+\`["ok" => false, "err" => \\Exception]\` on failure. Branch on \`$result["ok"]\`.
 
 **Parameters:**
 
@@ -139,11 +154,12 @@ Make a direct HTTP request to any API endpoint. Returns \`[$result, $err]\`.
 | \`$fetchargs["body"]\` | \`mixed\` | Request body (arrays are JSON-serialized). |
 | \`$fetchargs["ctrl"]\` | \`array\` | Control options. |
 
-**Returns:** \`array [$result, $err]\`
+**Returns:** \`array\` — the result dict (see above); never throws.
 
-#### \`prepare(array $fetchargs = []): array\`
+#### \`prepare(array $fetchargs = []): mixed\`
 
-Prepare a fetch definition without sending the request. Returns \`[$fetchdef, $err]\`.
+Prepare a fetch definition without sending the request. Returns the
+\`$fetchdef\` array. Throws on error.
 
 `)
 
@@ -152,6 +168,9 @@ Prepare a fetch definition without sending the request. Returns \`[$fetchdef, $e
     publishedEntities.map((ent: any) => {
       const opnames = Object.keys(ent.op || {})
       const fields = ent.fields || []
+      // Model-driven id key: null when this entity has no id-like field, in
+      // which case load/remove match on no argument and update omits the id.
+      const idF = entityIdField(ent)
 
       Content(`
 ---
@@ -183,7 +202,7 @@ $${ent.name} = $client->${ent.Name}();
         each(fields, (field: any) => {
           const req = field.req ? 'Yes' : 'No'
           const desc = field.short || ''
-          Content(`| \`${field.name}\` | \`${field.type || 'any'}\` | ${req} | ${desc} |
+          Content(`| \`${field.name}\` | \`${canonToType(field.type, target.name)}\` | ${req} | ${desc} |
 `)
         })
 
@@ -193,15 +212,18 @@ $${ent.name} = $client->${ent.Name}();
         // Field operations breakdown
         const hasFieldOps = fields.some((f: any) => f.op && Object.keys(f.op).length > 0)
         if (hasFieldOps) {
+          // Only emit columns for operations this entity actually exposes —
+          // never advertise a create/update/remove column the entity lacks.
+          const opcols = ['load', 'list', 'create', 'update', 'remove']
+            .filter((op: string) => opnames.includes(op) && ent.op[op]?.active !== false)
           Content(`### Field Usage by Operation
 
-| Field | load | list | create | update | remove |
-| --- | --- | --- | --- | --- | --- |
+| Field | ${opcols.join(' | ')} |
+| --- | ${opcols.map(() => '---').join(' | ')} |
 `)
           each(fields, (field: any) => {
             const fops = field.op || {}
-            const cols = ['load', 'list', 'create', 'update', 'remove'].map((op: string) => {
-              if (!opnames.includes(op)) return '-'
+            const cols = opcols.map((op: string) => {
               const fop = fops[op]
               if (null == fop) return '-'
               if (fop.active === false) return '-'
@@ -235,28 +257,43 @@ ${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) =>
+                `"${it.name}" => ${phpLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)}`).join(', ')}]`
+              : ''
             Content(`\`\`\`php
-[$result, $err] = $client->${ent.Name}()->${opname}(["id" => "${ent.name}_id"]);
+$result = $client->${ent.Name}()->${opname}(${arg});
 \`\`\`
 
 `)
           }
           else if ('list' === opname) {
             Content(`\`\`\`php
-[$results, $err] = $client->${ent.Name}()->list([]);
+$results = $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.
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
             Content(`\`\`\`php
-[$result, $err] = $client->${ent.Name}()->create([
+$result = $client->${ent.Name}()->create([
 `)
-            each(fields, (field: any) => {
-              if ('id' !== field.name && field.req) {
-                Content(`  "${field.name}" => /* ${field.type || 'value'} */,
+            createItems.map((it: any) => {
+              Content(`  "${it.name}" => null, // ${canonToType(it.type, target.name)}
 `)
-              }
             })
             Content(`]);
 \`\`\`
@@ -264,10 +301,18 @@ ${info.desc}
 `)
           }
           else if ('update' === opname) {
+            // 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) =>
+              `  "${it.name}" => ${phpLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)},\n`).join('')
             Content(`\`\`\`php
-[$result, $err] = $client->${ent.Name}()->update([
-  "id" => "${ent.name}_id",
-  // Fields to update
+$result = $client->${ent.Name}()->update([
+${updateLines}  // Fields to update
 ]);
 \`\`\`
 
@@ -280,19 +325,19 @@ ${info.desc}
       // Common methods
       Content(`### Common Methods
 
-#### \`dataGet(): array\`
+#### \`data_get(): array\`
 
 Get the entity data. Returns a copy of the current data.
 
-#### \`dataSet($data): void\`
+#### \`data_set($data): void\`
 
 Set the entity data.
 
-#### \`matchGet(): array\`
+#### \`match_get(): array\`
 
 Get the entity match criteria.
 
-#### \`matchSet($match): void\`
+#### \`match_set($match): void\`
 
 Set the entity match criteria.
 
@@ -301,7 +346,7 @@ Set the entity match criteria.
 Create a new \`${ent.Name}Entity\` instance with the same client and
 options.
 
-#### \`getName(): string\`
+#### \`get_name(): string\`
 
 Return the entity name.
 

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

@@ -7,7 +7,7 @@ const ReadmeTopHowto = cmp(function ReadmeTopHowto(props: any) {
 
   Content(`**PHP:**
 \`\`\`php
-[$result, $err] = $client->direct([
+$result = $client->direct([
     "path" => "/api/resource/{id}",
     "method" => "GET",
     "params" => ["id" => "example"],

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

@@ -1,5 +1,5 @@
 
-import { cmp, Content, isAuthActive } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive, envName, canonKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -8,6 +8,18 @@ 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 this block, so a comment placeholder would break it).
+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}"`
+}
+
+
 const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
   const { target, ctx$: { model } } = props
 
@@ -15,35 +27,55 @@ const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
 
   const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
 
-  const apikeyArg = isAuthActive(model)
-    ? `\n    "apikey" => getenv("${model.NAME}_APIKEY"),\n`
-    : ''
+  const authActive = isAuthActive(model)
+  const ctor = authActive
+    ? `new ${model.const.Name}SDK([\n    "apikey" => getenv("${envName(model)}_APIKEY"),\n])`
+    : `new ${model.const.Name}SDK()`
 
   Content(`\`\`\`php
 <?php
 require_once '${model.const.Name.toLowerCase()}_sdk.php';
 
-$client = new ${model.const.Name}SDK([${apikeyArg}]);
+$client = ${ctor};
 
 `)
 
   if (exampleEntity) {
     const eName = nom(exampleEntity, 'Name')
     const opnames = Object.keys(exampleEntity.op || {})
+    // Model-driven id key: null when the entity has no id-like field, in which
+    // case the load example takes no match argument.
+    const idF = entityIdField(exampleEntity)
+
+    let hasCall = false
 
     if (opnames.includes('list')) {
-      Content(`// List all ${eName.toLowerCase()}s
-[$${eName.toLowerCase()}s, $err] = $client->${eName}(null)->list(null, null);
+      Content(`// List all ${eName.toLowerCase()}s (returns an array; throws on error)
+$${eName.toLowerCase()}s = $client->${eName}()->list();
+print_r($${eName.toLowerCase()}s);
 `)
+      hasCall = true
     }
 
     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) =>
+          `"${it.name}" => ${phpLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)}`).join(', ')}]`
+        : ''
       Content(`
-// Load a specific ${eName.toLowerCase()}
-[$${eName.toLowerCase()}, $err] = $client->${eName}(null)->load(
-    ["id" => "example_id"], null
-);
+// Load a specific ${eName.toLowerCase()} (returns the bare record; throws on error)
+$${eName.toLowerCase()} = $client->${eName}()->load(${loadArg});
+print_r($${eName.toLowerCase()});
 `)
+      hasCall = true
     }
   }