Skip to content

Commit 677b1f4

Browse files
authored
docs: Say to use v2 claims. Update support statement (#1496)
* docs: Say to use v2 vs. v2 claims. Update support statement * Update release-notes.md
1 parent 84ee98a commit 677b1f4

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ For details on what you can do with the library, see [Using the Rust library](ht
4646

4747
This is a beta release (version 0.x.x) of the project. The minor version number (0.x.0) is incremented when there are breaking API changes, which may happen frequently.
4848

49-
**NOTE**: The library now supports [C2PA v2 claims](https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_claims), however development is still in progress and all features are not fully implemented yet. While you can experiment with this functionality, it is not recommended for production use at this time. For details, see [C2PA v2 claims](https://opensource.contentauthenticity.org/docs/rust-sdk/docs/release-notes#c2pa-v2-claims).
49+
**NOTE**: The library supports [C2PA v2 claims](https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_claims) by default, and implementations should not generate deprecated v1 claims. For details, see [C2PA v2 claims](https://opensource.contentauthenticity.org/docs/rust-sdk/docs/release-notes#c2pa-v2-claims).
5050

5151
### New API
5252

docs/release-notes.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,12 @@ An `AssetType` assertion is now supported.
2424

2525
### C2PA v2 claims
2626

27-
**NOTE**: The library now supports [C2PA v2 claims](https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_claims) by default.
27+
**NOTE**: The library now supports [C2PA v2 claims](https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_claims) by default. V2 claims have many new checks and status codes. Additionally:
2828

29-
To generate v1 claims, set the `Builder` manifest definition `claim_version` field to `1`.
29+
- The `title()` and `format()` methods of both `Manifest` and `Ingredient` objects now return an `Option<String>` because in v2 claims, `title` is optional and `format` does not exist.
30+
- The first `action` must be `c2pa.created` or `c2pa.opened` (which requires an ingredient).
3031

31-
The `title()` and `format()` methods of both `Manifest` and `Ingredient` objects now return an `Option<String>` because in v2 claims, `title` is optional and `format` does not exist.
32-
33-
In v2 claims, the first `action` must be `c2pa.created` or `c2pa.opened`.
34-
35-
V2 claims have many new checks and status codes.
32+
WARNING: Implementations should not generate deprecated v1 claims. If needed, though, you can generate v1 claims by setting the `Builder` manifest definition `claim_version` field to `1`.
3633

3734
### Using the old API
3835

@@ -42,7 +39,7 @@ To use the old deprecated API, enable the `v1_api` feature; for example:
4239
c2pa = {version="0.45.2", features=["v1_api"]}
4340
```
4441

45-
This will be the last release with the v1_api feature available.
42+
This will be the last release with the `v1_api` feature available.
4643

4744
## Language binding support
4845

0 commit comments

Comments
 (0)