@shoalrun/cli 0.1.0-alpha.16 → 0.1.0-alpha.18

package/agent-docs/content-delivery/http-api/operations/get-content-resource-849f1c49.md

@@ -16,11 +16,11 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
 
 Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Content REST API > Other > Read resource metadata
 
-**Updated: 2026-09-27.**
+**Updated: 2026-11-05.**
 
 This reference is generated from the OpenAPI description. It shows the operation contract; follow any related guides below for task steps and context.
 
-OpenAPI for this operation: [Download JSON](https://www.shoalrun.com/api/operations/production/current/en/content-rest-getcontentresource-4b468f0730abbf5c55d4ff2f678fc6f5f742e2032607aeae96fcc11fb62addb4.json).
+OpenAPI for this operation: [Download JSON](https://www.shoalrun.com/api/operations/production/current/en/content-rest-getcontentresource-a549314e9e6b6cf47c6d6a219960eb28bb03dbfee65464b87b2d6d45a2dda923.json).
 
 ## GET /resources/{key}
 
@@ -64,6 +64,14 @@ string; minLength: 1; maxLength: 2048
 
 **Default example**: `"en"`
 
+#### product (query)
+
+Optional
+
+Exact product ID. Required for product-scoped publications; omitted selects only a legacy productless publication. No cross-product fallback.
+
+string; minLength: 1; maxLength: 2048
+
 #### revision (query)
 
 Required
@@ -129,6 +137,12 @@ Serialization: simple; explode: false.
 
 string
 
+The response has exactly one of these shapes:
+
+**Shape 1** · 5 properties
+
+object
+
 5 properties
 
 - `schemaVersion` `number` **always present** 
@@ -169,7 +183,7 @@ string
 
   - `publication` `object` **always present** 
 
-    3 properties
+    4 properties
 
     - `channel` `string` **always present** 
 
@@ -183,6 +197,526 @@ string
 
       minLength: 1
 
+    - `product` `string` **may be absent** 
+
+      minLength: 1
+
+    Additional properties: not allowed.
+
+  - `title` `string` **always present** 
+
+  - `summary` `string` **always present** 
+
+  - `type` `string` **always present** 
+
+  - `canonicalUrl` `string` **may be absent** 
+
+    format: uri
+
+  - `representations` `object` **always present** 
+
+    minProperties: 1
+
+    2 properties
+
+    - `html` `object` **may be absent** 
+
+      6 properties
+
+      - `path` `string` **always present** 
+
+        pattern: ^(?:NOTICES\\.txt|(?:content|assets)/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+(?:/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+)\*)$
+
+      - `bytes` `integer` **always present** 
+
+        minimum: 0
+
+      - `digest` `string` **always present** 
+
+        pattern: ^\[a-f0-9]{64}$
+
+      - `mediaType` `string` **always present** 
+
+      - `anchors` `list of object` **always present** 
+
+        Array items:
+
+        object
+
+        3 properties
+
+        - `id` `string` **always present** 
+
+        - `exportedId` `string` **always present** 
+
+        - `title` `string` **may be absent** 
+
+        Additional properties: not allowed.
+
+      - `links` `list of one of several types` **always present** 
+
+        Array items:
+
+        The response has exactly one of these shapes:
+
+        **Shape 1** · 6 properties
+
+        object
+
+        6 properties
+
+        - `key` `string` **always present** 
+
+        - `kind` `enum<string>` **always present**&#x20;
+
+          Available options: `"resource"`
+
+        - `href` `string` **always present**&#x20;
+
+        - `fragment` `string` **may be absent**&#x20;
+
+        - `query` `string` **may be absent**&#x20;
+
+        - `ref` `one of several types` **always present**&#x20;
+
+          The response has exactly one of these shapes:
+
+          **Shape 1** · 2 properties
+
+          object
+
+          2 properties
+
+          - `kind` `string` **always present**&#x20;
+
+            const: "page"
+
+          - `documentId` `string` **always present**&#x20;
+
+            minLength: 1
+
+          Additional properties: not allowed.
+
+          **Shape 2** · 3 properties
+
+          object
+
+          3 properties
+
+          - `kind` `string` **always present**&#x20;
+
+            const: "section"
+
+          - `documentId` `string` **always present**&#x20;
+
+            minLength: 1
+
+          - `sectionId` `string` **always present**&#x20;
+
+            pattern: ^\[a-z0-9]\[a-z0-9-]{0,511}$
+
+          Additional properties: not allowed.
+
+          **Shape 3** · 2 properties
+
+          object
+
+          2 properties
+
+          - `kind` `string` **always present**&#x20;
+
+            const: "snippet"
+
+          - `id` `string` **always present**&#x20;
+
+            pattern: ^\[A-Za-z\_]\[A-Za-z0-9\_.-]\*$
+
+          Additional properties: not allowed.
+
+        Additional properties: not allowed.
+
+        **Shape 2** · 6 properties
+
+        object
+
+        6 properties
+
+        - `key` `string` **always present**&#x20;
+
+        - `kind` `enum<string>` **always present**&#x20;
+
+          Available options: `"asset"`
+
+        - `href` `string` **always present**&#x20;
+
+        - `fragment` `string` **may be absent**&#x20;
+
+        - `query` `string` **may be absent**&#x20;
+
+        - `asset` `string` **always present**&#x20;
+
+          pattern: ^(?:NOTICES\\.txt|(?:content|assets)/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+(?:/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+)\*)$
+
+        Additional properties: not allowed.
+
+        **Shape 3** · 5 properties
+
+        object
+
+        5 properties
+
+        - `key` `string` **always present**&#x20;
+
+        - `kind` `enum<string>` **always present**&#x20;
+
+          Available options: `"canonical"`, `"external"`
+
+        - `href` `string` **always present**&#x20;
+
+        - `fragment` `string` **may be absent**&#x20;
+
+        - `query` `string` **may be absent**&#x20;
+
+        Additional properties: not allowed.
+
+      Additional properties: not allowed.
+
+    - `markdown` `object` **may be absent**&#x20;
+
+      6 properties
+
+      - `path` `string` **always present**&#x20;
+
+        pattern: ^(?:NOTICES\\.txt|(?:content|assets)/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+(?:/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+)\*)$
+
+      - `bytes` `integer` **always present**&#x20;
+
+        minimum: 0
+
+      - `digest` `string` **always present**&#x20;
+
+        pattern: ^\[a-f0-9]{64}$
+
+      - `mediaType` `string` **always present**&#x20;
+
+      - `anchors` `list of object` **always present**&#x20;
+
+        Array items:
+
+        object
+
+        3 properties
+
+        - `id` `string` **always present**&#x20;
+
+        - `exportedId` `string` **always present**&#x20;
+
+        - `title` `string` **may be absent**&#x20;
+
+        Additional properties: not allowed.
+
+      - `links` `list of one of several types` **always present**&#x20;
+
+        Array items:
+
+        The response has exactly one of these shapes:
+
+        **Shape 1** · 6 properties
+
+        object
+
+        6 properties
+
+        - `key` `string` **always present**&#x20;
+
+        - `kind` `enum<string>` **always present**&#x20;
+
+          Available options: `"resource"`
+
+        - `href` `string` **always present**&#x20;
+
+        - `fragment` `string` **may be absent**&#x20;
+
+        - `query` `string` **may be absent**&#x20;
+
+        - `ref` `one of several types` **always present**&#x20;
+
+          The response has exactly one of these shapes:
+
+          **Shape 1** · 2 properties
+
+          object
+
+          2 properties
+
+          - `kind` `string` **always present**&#x20;
+
+            const: "page"
+
+          - `documentId` `string` **always present**&#x20;
+
+            minLength: 1
+
+          Additional properties: not allowed.
+
+          **Shape 2** · 3 properties
+
+          object
+
+          3 properties
+
+          - `kind` `string` **always present**&#x20;
+
+            const: "section"
+
+          - `documentId` `string` **always present**&#x20;
+
+            minLength: 1
+
+          - `sectionId` `string` **always present**&#x20;
+
+            pattern: ^\[a-z0-9]\[a-z0-9-]{0,511}$
+
+          Additional properties: not allowed.
+
+          **Shape 3** · 2 properties
+
+          object
+
+          2 properties
+
+          - `kind` `string` **always present**&#x20;
+
+            const: "snippet"
+
+          - `id` `string` **always present**&#x20;
+
+            pattern: ^\[A-Za-z\_]\[A-Za-z0-9\_.-]\*$
+
+          Additional properties: not allowed.
+
+        Additional properties: not allowed.
+
+        **Shape 2** · 6 properties
+
+        object
+
+        6 properties
+
+        - `key` `string` **always present**&#x20;
+
+        - `kind` `enum<string>` **always present**&#x20;
+
+          Available options: `"asset"`
+
+        - `href` `string` **always present**&#x20;
+
+        - `fragment` `string` **may be absent**&#x20;
+
+        - `query` `string` **may be absent**&#x20;
+
+        - `asset` `string` **always present**&#x20;
+
+          pattern: ^(?:NOTICES\\.txt|(?:content|assets)/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+(?:/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+)\*)$
+
+        Additional properties: not allowed.
+
+        **Shape 3** · 5 properties
+
+        object
+
+        5 properties
+
+        - `key` `string` **always present**&#x20;
+
+        - `kind` `enum<string>` **always present**&#x20;
+
+          Available options: `"canonical"`, `"external"`
+
+        - `href` `string` **always present**&#x20;
+
+        - `fragment` `string` **may be absent**&#x20;
+
+        - `query` `string` **may be absent**&#x20;
+
+        Additional properties: not allowed.
+
+      Additional properties: not allowed.
+
+    Additional properties: not allowed.
+
+  - `assets` `list of string` **always present**&#x20;
+
+    uniqueItems: true
+
+    Array items:
+
+    string; pattern: ^(?:NOTICES\\.txt|(?:content|assets)/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+(?:/(?!\\.{1,2}(?:/|$))\[A-Za-z0-9\_.-]+)\*)$
+
+  - `externalDependencies` `list of object` **always present**&#x20;
+
+    Array items:
+
+    object
+
+    2 properties
+
+    - `url` `string` **always present**&#x20;
+
+      format: uri
+
+    - `kind` `string` **always present**&#x20;
+
+      const: "image"
+
+    Additional properties: not allowed.
+
+  - `ref` `one of several types` **always present**&#x20;
+
+    The response has exactly one of these shapes:
+
+    **Shape 1** · 2 properties
+
+    object
+
+    2 properties
+
+    - `kind` `string` **always present**&#x20;
+
+      const: "page"
+
+    - `documentId` `string` **always present**&#x20;
+
+      minLength: 1
+
+    Additional properties: not allowed.
+
+    **Shape 2** · 3 properties
+
+    object
+
+    3 properties
+
+    - `kind` `string` **always present**&#x20;
+
+      const: "section"
+
+    - `documentId` `string` **always present**&#x20;
+
+      minLength: 1
+
+    - `sectionId` `string` **always present**&#x20;
+
+      pattern: ^\[a-z0-9]\[a-z0-9-]{0,511}$
+
+    Additional properties: not allowed.
+
+    **Shape 3** · 2 properties
+
+    object
+
+    2 properties
+
+    - `kind` `string` **always present**&#x20;
+
+      const: "snippet"
+
+    - `id` `string` **always present**&#x20;
+
+      pattern: ^\[A-Za-z\_]\[A-Za-z0-9\_.-]\*$
+
+    Additional properties: not allowed.
+
+  - `source` `object` **may be absent**&#x20;
+
+    minProperties: 1
+
+    3 properties
+
+    - `documentId` `string` **may be absent**&#x20;
+
+      minLength: 1
+
+    - `snippetId` `string` **may be absent**&#x20;
+
+      minLength: 1
+
+    - `valuesDigest` `string` **may be absent**&#x20;
+
+      pattern: ^\[a-f0-9]{64}$
+
+    Additional properties: not allowed.
+
+  Additional properties: not allowed.
+
+Additional properties: not allowed.
+
+**Shape 2** · 5 properties
+
+object
+
+5 properties
+
+- `schemaVersion` `number` **always present**&#x20;
+
+  const: 2
+
+- `revision` `string` **always present**&#x20;
+
+  pattern: ^\[a-f0-9]{64}$
+
+- `publication` `object` **always present**&#x20;
+
+  4 properties
+
+  - `channel` `string` **always present**&#x20;
+
+    minLength: 1
+
+  - `version` `string` **always present**&#x20;
+
+    minLength: 1
+
+  - `language` `string` **always present**&#x20;
+
+    minLength: 1
+
+  - `product` `string` **always present**&#x20;
+
+    minLength: 1
+
+  Additional properties: not allowed.
+
+- `key` `string` **always present**&#x20;
+
+  Opaque stable typed-reference key. Use the returned key. It is k\_ followed by unpadded base64url of UTF-8 JSON for \["page",documentId], \["section",documentId,sectionId], or \["snippet",id]. Publication and revision are separate selectors.
+
+  pattern: ^k\_\[A-Za-z0-9\_-]+$
+
+- `resource` `object` **always present**&#x20;
+
+  10 properties
+
+  - `publication` `object` **always present**&#x20;
+
+    4 properties
+
+    - `channel` `string` **always present**&#x20;
+
+      minLength: 1
+
+    - `version` `string` **always present**&#x20;
+
+      minLength: 1
+
+    - `language` `string` **always present**&#x20;
+
+      minLength: 1
+
+    - `product` `string` **may be absent**&#x20;
+
+      minLength: 1
+
     Additional properties: not allowed.
 
   - `title` `string` **always present**&#x20;

package/agent-docs/content-delivery/http-api/operations/get-content-resource-head-0a352acd.md

@@ -16,11 +16,11 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
 
 Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > Content REST API > Other > Read resource metadata headers
 
-**Updated: 2026-10-28.**
+**Updated: 2026-11-05.**
 
 This reference is generated from the OpenAPI description. It shows the operation contract; follow any related guides below for task steps and context.
 
-OpenAPI for this operation: [Download JSON](https://www.shoalrun.com/api/operations/production/current/en/content-rest-getcontentresourcehead-49278b5d587407017389307aa792900c49ecece639e9d4cd3aefd8c1b1245254.json).
+OpenAPI for this operation: [Download JSON](https://www.shoalrun.com/api/operations/production/current/en/content-rest-getcontentresourcehead-2bbdd35b7b5c9fc69bdbca76d615f9db3210df6a0040b49074f2055aef5e0ac8.json).
 
 ## HEAD /resources/{key}
 
@@ -64,6 +64,14 @@ string; minLength: 1; maxLength: 2048
 
 **Default example**: `"en"`
 
+#### product (query)
+
+Optional
+
+Exact product ID. Required for product-scoped publications; omitted selects only a legacy productless publication. No cross-product fallback.
+
+string; minLength: 1; maxLength: 2048
+
 #### revision (query)
 
 Required