@arke-institute/sdk 3.6.15 → 3.6.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/index.d.cts +20 -2
- package/dist/generated/index.d.ts +20 -2
- package/openapi/spec.json +15 -2
- package/openapi/version.json +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-03-
|
|
9
|
+
* Generated: 2026-03-13T00:32:55.503Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/ops-reference": {
|
|
@@ -5254,6 +5254,10 @@ type paths = {
|
|
|
5254
5254
|
* - Multiple updates from the same actor are merged before applying (one version)
|
|
5255
5255
|
* - Updates from different actors create separate versions (preserves audit trail)
|
|
5256
5256
|
*
|
|
5257
|
+
* **Permission Check:**
|
|
5258
|
+
* - Each target entity is checked for `entity:update` permission before queueing
|
|
5259
|
+
* - If any entity fails the permission check, the entire batch is rejected
|
|
5260
|
+
*
|
|
5257
5261
|
* **Use Cases:**
|
|
5258
5262
|
* - Many workers adding relationships to a shared parent entity
|
|
5259
5263
|
* - High-volume indexing where multiple sources enrich the same entity
|
|
@@ -5326,6 +5330,20 @@ type paths = {
|
|
|
5326
5330
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
5327
5331
|
};
|
|
5328
5332
|
};
|
|
5333
|
+
/** @description Forbidden - Insufficient permissions */
|
|
5334
|
+
403: {
|
|
5335
|
+
headers: {
|
|
5336
|
+
[name: string]: unknown;
|
|
5337
|
+
};
|
|
5338
|
+
content: {
|
|
5339
|
+
/**
|
|
5340
|
+
* @example {
|
|
5341
|
+
* "error": "Forbidden: You do not have permission to perform this action"
|
|
5342
|
+
* }
|
|
5343
|
+
*/
|
|
5344
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
5345
|
+
};
|
|
5346
|
+
};
|
|
5329
5347
|
};
|
|
5330
5348
|
};
|
|
5331
5349
|
delete?: never;
|
|
@@ -12980,7 +12998,7 @@ type components = {
|
|
|
12980
12998
|
target_entities?: string[];
|
|
12981
12999
|
/** @description Collection for permission grant. All kladoi in workflow receive temporal permissions on this collection. */
|
|
12982
13000
|
target_collection: string;
|
|
12983
|
-
/** @description
|
|
13001
|
+
/** @description Optional input data forwarded to every klados in the workflow via request.input. Supports three-level priority merging: (1) flow-level step defaults (lowest), (2) global keys here (middle), (3) per-step overrides via a "steps" key (highest). Example: { "custom_instructions": "global override", "steps": { "describe": { "style": "brief" } } } — global keys apply to all steps, while steps.describe only applies to the "describe" step, overriding both global and flow defaults. */
|
|
12984
13002
|
input?: {
|
|
12985
13003
|
[key: string]: unknown;
|
|
12986
13004
|
};
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-03-
|
|
9
|
+
* Generated: 2026-03-13T00:32:55.503Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/ops-reference": {
|
|
@@ -5254,6 +5254,10 @@ type paths = {
|
|
|
5254
5254
|
* - Multiple updates from the same actor are merged before applying (one version)
|
|
5255
5255
|
* - Updates from different actors create separate versions (preserves audit trail)
|
|
5256
5256
|
*
|
|
5257
|
+
* **Permission Check:**
|
|
5258
|
+
* - Each target entity is checked for `entity:update` permission before queueing
|
|
5259
|
+
* - If any entity fails the permission check, the entire batch is rejected
|
|
5260
|
+
*
|
|
5257
5261
|
* **Use Cases:**
|
|
5258
5262
|
* - Many workers adding relationships to a shared parent entity
|
|
5259
5263
|
* - High-volume indexing where multiple sources enrich the same entity
|
|
@@ -5326,6 +5330,20 @@ type paths = {
|
|
|
5326
5330
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
5327
5331
|
};
|
|
5328
5332
|
};
|
|
5333
|
+
/** @description Forbidden - Insufficient permissions */
|
|
5334
|
+
403: {
|
|
5335
|
+
headers: {
|
|
5336
|
+
[name: string]: unknown;
|
|
5337
|
+
};
|
|
5338
|
+
content: {
|
|
5339
|
+
/**
|
|
5340
|
+
* @example {
|
|
5341
|
+
* "error": "Forbidden: You do not have permission to perform this action"
|
|
5342
|
+
* }
|
|
5343
|
+
*/
|
|
5344
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
5345
|
+
};
|
|
5346
|
+
};
|
|
5329
5347
|
};
|
|
5330
5348
|
};
|
|
5331
5349
|
delete?: never;
|
|
@@ -12980,7 +12998,7 @@ type components = {
|
|
|
12980
12998
|
target_entities?: string[];
|
|
12981
12999
|
/** @description Collection for permission grant. All kladoi in workflow receive temporal permissions on this collection. */
|
|
12982
13000
|
target_collection: string;
|
|
12983
|
-
/** @description
|
|
13001
|
+
/** @description Optional input data forwarded to every klados in the workflow via request.input. Supports three-level priority merging: (1) flow-level step defaults (lowest), (2) global keys here (middle), (3) per-step overrides via a "steps" key (highest). Example: { "custom_instructions": "global override", "steps": { "describe": { "style": "brief" } } } — global keys apply to all steps, while steps.describe only applies to the "describe" step, overriding both global and flow defaults. */
|
|
12984
13002
|
input?: {
|
|
12985
13003
|
[key: string]: unknown;
|
|
12986
13004
|
};
|
package/openapi/spec.json
CHANGED
|
@@ -7495,7 +7495,7 @@
|
|
|
7495
7495
|
"additionalProperties": {
|
|
7496
7496
|
"nullable": true
|
|
7497
7497
|
},
|
|
7498
|
-
"description": "
|
|
7498
|
+
"description": "Optional input data forwarded to every klados in the workflow via request.input. Supports three-level priority merging: (1) flow-level step defaults (lowest), (2) global keys here (middle), (3) per-step overrides via a \"steps\" key (highest). Example: { \"custom_instructions\": \"global override\", \"steps\": { \"describe\": { \"style\": \"brief\" } } } — global keys apply to all steps, while steps.describe only applies to the \"describe\" step, overriding both global and flow defaults."
|
|
7499
7499
|
},
|
|
7500
7500
|
"expires_in": {
|
|
7501
7501
|
"type": "integer",
|
|
@@ -14084,7 +14084,7 @@
|
|
|
14084
14084
|
"Batch"
|
|
14085
14085
|
],
|
|
14086
14086
|
"summary": "Queue additive updates (fire-and-forget)",
|
|
14087
|
-
"description": "Queues additive updates for multiple entities. Returns 202 Accepted immediately.\n\n**Fire-and-Forget Semantics:**\n- Updates are queued and processed asynchronously\n- CAS conflicts are handled internally with exponential backoff retry\n- Client does not need to retry on conflicts\n\n**Additive-Only Operations:**\n- `properties`: Deep merged with existing properties\n- `relationships_add`: Upsert semantics (add new or merge properties)\n- `properties_remove` and `relationships_remove` are **NOT supported** - use `PUT /entities/:id` for removals\n\n**Per-Actor Versioning:**\n- Multiple updates from the same actor are merged before applying (one version)\n- Updates from different actors create separate versions (preserves audit trail)\n\n**Use Cases:**\n- Many workers adding relationships to a shared parent entity\n- High-volume indexing where multiple sources enrich the same entity\n- Any scenario where ordering doesn't matter and CAS conflicts are expected\n\n**Max batch size:** 100 updates per request.\n\n---\n**Permission:** `entity:update` \n**Auth:** required",
|
|
14087
|
+
"description": "Queues additive updates for multiple entities. Returns 202 Accepted immediately.\n\n**Fire-and-Forget Semantics:**\n- Updates are queued and processed asynchronously\n- CAS conflicts are handled internally with exponential backoff retry\n- Client does not need to retry on conflicts\n\n**Additive-Only Operations:**\n- `properties`: Deep merged with existing properties\n- `relationships_add`: Upsert semantics (add new or merge properties)\n- `properties_remove` and `relationships_remove` are **NOT supported** - use `PUT /entities/:id` for removals\n\n**Per-Actor Versioning:**\n- Multiple updates from the same actor are merged before applying (one version)\n- Updates from different actors create separate versions (preserves audit trail)\n\n**Permission Check:**\n- Each target entity is checked for `entity:update` permission before queueing\n- If any entity fails the permission check, the entire batch is rejected\n\n**Use Cases:**\n- Many workers adding relationships to a shared parent entity\n- High-volume indexing where multiple sources enrich the same entity\n- Any scenario where ordering doesn't matter and CAS conflicts are expected\n\n**Max batch size:** 100 updates per request.\n\n---\n**Permission:** `entity:update` \n**Auth:** required",
|
|
14088
14088
|
"x-arke-action": "entity:update",
|
|
14089
14089
|
"x-arke-auth": "required",
|
|
14090
14090
|
"x-arke-tier": "standard",
|
|
@@ -14152,6 +14152,19 @@
|
|
|
14152
14152
|
}
|
|
14153
14153
|
}
|
|
14154
14154
|
}
|
|
14155
|
+
},
|
|
14156
|
+
"403": {
|
|
14157
|
+
"description": "Forbidden - Insufficient permissions",
|
|
14158
|
+
"content": {
|
|
14159
|
+
"application/json": {
|
|
14160
|
+
"schema": {
|
|
14161
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
14162
|
+
},
|
|
14163
|
+
"example": {
|
|
14164
|
+
"error": "Forbidden: You do not have permission to perform this action"
|
|
14165
|
+
}
|
|
14166
|
+
}
|
|
14167
|
+
}
|
|
14155
14168
|
}
|
|
14156
14169
|
}
|
|
14157
14170
|
}
|
package/openapi/version.json
CHANGED