Skip to content

Commit cf2030f

Browse files
committed
Updates re instance id
1 parent 5196c50 commit cf2030f

File tree

1 file changed

+34
-33
lines changed

1 file changed

+34
-33
lines changed

docs/manifest/assertions-actions.md

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ The `parameters` property can contain any data that provide more details on the
381381
]
382382
```
383383

384-
When creating an actions assertion that has an associated ingredient, the `parameters` object must include a `org.cai.ingredientIds` property with an array of one or more [`instanceID` values](#the-instanceid-property) from ingredients. This is how you associate an action with one or more ingredients.
384+
When creating an actions assertion that has an associated ingredient, the `parameters` object must include a `org.cai.ingredientIds` property with an array of one or more [`instance_id` values](#the-instance_id-property) from ingredients. This is how you associate an action with one or more ingredients.
385385

386386
:::info
387387
The [C2PA specification](https://c2pa.org/specifications/specifications/2.1/specs/C2PA_Specification.html#_parameters) requires that a `c2pa.transcoded`, `c2pa.repackaged`, `c2pa.opened`, or a `c2pa.placed` action have one or more associated ingredients, so it is very important to add the `org.cai.ingredientIds` parameter with a matching ingredient.
@@ -406,72 +406,73 @@ The SDK supports the older `ingredientId` field, but it is deprecated and will a
406406

407407
For more information on action parameters, see the [C2PA Technical Specification](https://c2pa.org/specifications/specifications/1.4/specs/C2PA_Specification.html#_parameters).
408408

409-
### The instanceId property
409+
### The instance_id property
410410

411-
The `instanceId` property identifies an ingredient (with a matching value of `instance_id`) used in an action and is only used when defining/writing a manifest, not reading one.
411+
The `instance_id` property identifies an ingredient used in an action and is only used when defining/writing a manifest, not reading one.
412412

413-
```json
413+
Any `c2pa.opened` or `c2pa.placed` action must have an associated ingredient identified by the `org.cai.ingredientIds` parameters field of the action with an array of ingredient `instance_id` values.
414+
415+
```json
414416
"ingredients": [
415417
{
416418
...
417419
"instance_id": "<String-instance-ID-of-ingredient>",
418-
...
420+
"relationship": "parentOf",
421+
"label": "c2pa.ingredient.v3"
419422
},
420-
...
423+
...
424+
],
421425
"actions": [
422426
{
423427
"action": "c2pa.*",
424-
"instanceId": "<String-instance-ID-of-ingredient>",
425428
"parameters": {
426-
"ingredient": {
427-
"hash": "tTBD4/E0R0AjLUdJFpsVz3lE/KJUq22Vz0UGqzhEpVs=",
428-
"url": "self#jumbf=c2pa.assertions/c2pa.ingredient"
429-
}
429+
"org.cai.ingredientIds": [
430+
"<String-instance-ID-of-ingredient>"
431+
],
432+
"ingredients": [
433+
{
434+
"url": "self#jumbf=c2pa.assertions/c2pa.ingredient.v3",
435+
"hash": "9wKCCcWI00zA1nBOrTc4bCX6UZuIehbwaviDoIWpw84="
436+
}
437+
]
430438
}
431439
},
432440
...
433441
]
434442
```
435443

436-
For example, the following action identifies that the `c2pa.opened` action was performed on the ingredient with ID `xmp.did:813ee422-9736-4cdc-9be6-4e35ed8e41cb`:
444+
For example, the following action identifies that the `c2pa.opened` action was performed on the ingredient with ID `xmp.iid:3250038a-22ca-459b-8392-de275f8b155c`:
437445

438446
```json
439447
"ingredients": [
440448
{
441-
"title": "A.jpg",
449+
"title": "test.jpeg",
442450
"format": "image/jpeg",
443-
"document_id": "xmp.did:813ee422-9736-4cdc-9be6-4e35ed8e41cb",
444-
"instance_id": "xmp.iid:813ee422-9736-4cdc-9be6-4e35ed8e41cb",
445-
"thumbnail": {
446-
"format": "image/jpeg",
447-
"identifier": "xmp.iid-813ee422-9736-4cdc-9be6-4e35ed8e41cb.jpg"
448-
},
449-
"relationship": "parentOf"
450-
},
451-
...
451+
"instance_id": "xmp.iid:3250038a-22ca-459b-8392-de275f8b155c",
452+
"relationship": "parentOf",
453+
"label": "c2pa.ingredient.v3"
454+
}
452455
],
453456
"assertions": [
454-
...
455457
{
456458
"label": "c2pa.actions",
457459
"data": {
458460
"actions": [
459461
{
460462
"action": "c2pa.opened",
461-
"instanceId": "xmp.iid:813ee422-9736-4cdc-9be6-4e35ed8e41cb",
462463
"parameters": {
463-
"ingredient": {
464-
"hash": "tTBD4/E0R0AjLUdJFpsVz3lE/KJUq22Vz0UGqzhEpVs=",
465-
"url": "self#jumbf=c2pa.assertions/c2pa.ingredient"
466-
}
464+
"org.cai.ingredientIds": [
465+
"xmp.iid:3250038a-22ca-459b-8392-de275f8b155c"
466+
],
467+
"ingredients": [
468+
{
469+
"url": "self#jumbf=c2pa.assertions/c2pa.ingredient.v3",
470+
"hash": "9wKCCcWI00zA1nBOrTc4bCX6UZuIehbwaviDoIWpw84="
471+
}
472+
]
467473
}
468474
},
469475
...
470-
]
471-
}
472-
}
473-
],
474-
...
475476
```
476477

477478
### V2 actions

0 commit comments

Comments
 (0)