Skip to content

Change org.cai.ingredientIds to IngredientIds #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 3, 2025
Merged

Change org.cai.ingredientIds to IngredientIds #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/manifest/assertions-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ Each object in the `actions` array has the following standard properties.
| `action` | Yes | The action name. See [Action names](#action-names). | `c2pa.created` |
| `digitalSourceType` | No | A URL identifying a [IPTC term](https://cv.iptc.org/newscodes/digitalsourcetype/). See [Digital source type](#digital-source-type). | `http://cv.iptc.org/newscodes/`<br/> `digitalsourcetype/digitalCapture` |
| `softwareAgent` | No | The software or hardware used to perform the action. | `"Adobe Firefly"` |
| `parameters` | No | Additional information describing the action; see [Parameters](#parameters) | Reference to ingredients in the `org.cai.ingredientIds` array. |
| `parameters` | No | Additional information describing the action; see [Parameters](#parameters) | Reference to ingredients in the `ingredientIds` array. |

### Action names

Expand Down Expand Up @@ -381,10 +381,10 @@ The `parameters` property can contain any data that provide more details on the
]
```

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.
When creating an actions assertion that has an associated ingredient, the `parameters` object must include a `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.

:::info
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.
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 `ingredientIds` parameter with a matching ingredient.
:::

For example:
Expand All @@ -394,7 +394,7 @@ For example:
{
"action": "c2pa.opened",
"parameters": {
"org.cai.ingredientIds": [
"ingredientIds": [
"xmp.iid:813ee422-9736-4cdc-9be6-4e35ed8e41cb"
]
}
Expand All @@ -412,7 +412,7 @@ For more information on action parameters, see the [C2PA Technical Specification

When defining/writing a manifest, the `instance_id` property identifies an ingredient used in an action.

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.
Any `c2pa.opened` or `c2pa.placed` action must have an associated ingredient identified by the `ingredientIds` parameters field of the action with an array of ingredient `instance_id` values. For example:

```json
"ingredients": [
Expand All @@ -428,7 +428,7 @@ Any `c2pa.opened` or `c2pa.placed` action must have an associated ingredient ide
{
"action": "c2pa.*",
"parameters": {
"org.cai.ingredientIds": [
"ingredientIds": [
"<String-instance-ID-of-ingredient>"
],
}
Expand Down Expand Up @@ -456,7 +456,7 @@ For example, the following action identifies that the `c2pa.opened` action was p
{
"action": "c2pa.opened",
"parameters": {
"org.cai.ingredientIds": [
"ingredientIds": [
"xmp.iid:3250038a-22ca-459b-8392-de275f8b155c"
],
}
Expand Down