Skip to content

Commit 0170bdc

Browse files
committed
Clean up for review
1 parent 20d3a57 commit 0170bdc

File tree

5 files changed

+16
-15
lines changed

5 files changed

+16
-15
lines changed

docs/manifest/reading/ingredients-reading.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ title: Reading ingredients
66
## Overview
77

88
Existing manifests may contain any of these three kinds of ingredients:
9-
- V1, with label `c2pa.ingredient` (deprecated).
10-
- V2, with label `c2pa.ingredient.v2` (deprecated).
11-
- V3, with label `c2pa.ingredient.v3`, which addresses the issue of validating ingredients after redaction.
9+
- V1, with labels starting with `c2pa.ingredient` (deprecated). See [Reading legacy manifest data](legacy.md#legacy-ingredients).
10+
- V2, with labels starting with `c2pa.ingredient.v2` (deprecated). See [Reading legacy manifest data](legacy.md#legacy-ingredients).
11+
- V3, with labels starting with `c2pa.ingredient.v3`, which addresses the issue of validating ingredients after redaction.
1212

1313
:::note
1414
The C2PA Technical Specification describes _ingredient assertions_ but the CAI SDK treats ingredients separately as their own objects in the JSON manifest rather than as a type of assertion.
@@ -20,6 +20,8 @@ The `ingredients` array contains an element for each ingredient used to create a
2020

2121
The `ingredients` array contains an [ingredient object](manifest/json-ref/manifest-def.mdx#ingredient) for each ingredient. The only required property of the `ingredient` object is the `title` property, which usually is the source file name.
2222

23+
The `label` property for the first ingredient in a manifest is `c2pa.ingredient.v3` When there is more than one ingredient, subsequent labels have a monotonically increasing index: `c2pa.ingredient.v3__1`, `c2pa.ingredient.v3__2`, and so on.
24+
2325
Other important properties of the ingredient object include:
2426
- `format`: MIME type of the source file (optional).
2527
- `document_id` (optional) and `instance_id` (required) which are derived from the ingredient asset's XMP metadata.

docs/manifest/reading/legacy.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ As much as possible, an application should **write** manifest data that conforms
77

88
## Legacy ingredients
99

10-
Existing manifests may contain any of these three kinds of ingredients:
11-
- V1, with label `c2pa.ingredient` (deprecated).
12-
- V2, with label `c2pa.ingredient.v2` (deprecated).
13-
- V3, with label `c2pa.ingredient.v3`, which addresses the issue of validating ingredients after redaction.
10+
Old manifests may contain these kinds of deprecated ingredient data:
11+
- V1 ingredients, with label `c2pa.ingredient`.
12+
- V2 ingredients, with label `c2pa.ingredient.v2`.
13+
14+
<a name="question"></a>
1415

1516
<div class="review-comment">
1617
What should we say about reading v1 and v2 ingredients?

docs/manifest/reading/reading-cawg-id.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following table describes the allowed values of the `type` property of `veri
6868
| Value | Meaning |
6969
|--------------|----------|
7070
| `cawg.document_verification` | The identity provider verified one or more government-issued identity documents presented by the content creator.
71-
| `cawg.web_site` | The content creator has proven control over a specific domain to the identity claims aggregator._
71+
| `cawg.web_site` | The content creator has proven control over a specific domain to the identity claims aggregator.
7272
| `cawg.affiliation` | The identity provider is attesting to the content creator’s membership in an organization. This could be a professional organization or an employment relationship.
7373
| `cawg.social_media` | The content creator has demonstrated control over an account (typically a social media account) hosted by the identity provider.
7474
| `cawg.crypto_wallet` | The content creator has demonstrated control over an account (typically a crypto-wallet) hosted by the identity provider.

docs/manifest/writing/assertions-actions.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Changes include:
3737

3838
The [C2PA Technical Specification](https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_actions) describes expanded v2 actions. While v1 actions are fully specified in the actions array v2 actions may either be specified by an element of the actions array or from an element in the templates array with the same action name.
3939

40+
<a name="question1"></a>
41+
4042
<div class="review-comment">
4143
The CAI APIs can read all v2 actions and write most v2 actions. What v2 actions can it NOT write?
4244
</div>
@@ -51,10 +53,6 @@ The C2PA Technical Specification defines a [set of standard assertions](https://
5153

5254
The following table summarizes some of the most important standard assertions.
5355

54-
<div class="review-comment">
55-
What other c2pa stadard assertions should we call out?
56-
</div>
57-
5856
| Assertion | Label | Description |
5957
|-----------|-------|-------------|
6058
| [Content bindings](#content-bindings) | `c2pa.hash.*`, `c2pa.soft-binding`, etc. | Uniquely identify portions of an asset and bind the assertion to it, for example using cryptographic hashes. |

docs/manifest/writing/ingredients.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ Digital assets are often not created entirely from scratch, but instead created
99

1010
[Old manifests](../reading/legacy.md) may contain deprecated v1 and v2 ingredients, but applications should only write v3 ingredients.
1111

12-
<div class="review-comment">
13-
This page should cover only v3 ingredients.
14-
</div>
12+
Applications should write only v3 ingredients, with label starting with `c2pa.ingredient.v3` and are described in the [C2PA specification](https://spec.c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#ingredient_assertion) .
1513

1614
:::note
1715
The C2PA Technical Specification describes _ingredient assertions_ but the CAI SDK treats ingredients separately as their own objects in the JSON manifest rather than as a type of assertion.
@@ -23,6 +21,8 @@ The `ingredients` array contains an element for each ingredient used to create a
2321

2422
The `ingredients` array contains an [ingredient object](manifest/json-ref/manifest-def.mdx#ingredient) for each ingredient. The only required property of the `ingredient` object is the `title` property, which usually is the source file name.
2523

24+
The `label` property for the first ingredient in a manifest is `c2pa.ingredient.v3` When there is more than one ingredient, subsequent labels have a monotonically increasing index: `c2pa.ingredient.v3__1`, `c2pa.ingredient.v3__2`, and so on.
25+
2626
Other important properties of the ingredient object include:
2727
- `format`: MIME type of the source file (optional).
2828
- `document_id` (optional) and `instance_id` (required) which are derived from the ingredient asset's XMP metadata.

0 commit comments

Comments
 (0)