Skip to content

feat: add OpenAPI schemas for credentials, presentations and JwsAlgorithm #126

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
daniel-mader merged 2 commits into from
Oct 26, 2026
+684 −10
Merged

feat: add OpenAPI schemas for credentials, presentations and JwsAlgorithm #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f9e16f
feat: OpenAPI schemas for credentials, presentations and `JwsAlgorithm`
claude Oct 26, 2026
b346508
Merge remote-tracking branch 'origin/main' into claude/inspiring-arch…
claude Oct 26, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ All features are additive; the lower layer (`did`, `jose`, `keys`, `identity`, `
| `domain-linkage` | ✅ | DIF Well Known DID Configuration (`domain_linkage`); implies `vc` and `did-web` |
| `linked-vp` | ✅ | DIF Linked Verifiable Presentation (`linked_vp`); implies `vc` and `did-web` |
| `jwks` | | `resolver::JwksResolver`: the keys of an HTTPS issuer from its JWT VC issuer metadata; implies `did-web` |
| `utoipa` | | OpenAPI schemas (`utoipa::ToSchema`) for `DidDocument`, `VerificationMethod`, `Service`, `Jwk`, `DomainLinkageConfiguration`, `ClaimPath` and `TypeMetadata` |
| `utoipa` | | OpenAPI schemas (`utoipa::ToSchema`) for `DidDocument`, `VerificationMethod`, `Service`, `Jwk`, `JwsAlgorithm`, `Credential`, `Presentation`, `CredentialV2`, `PresentationV2`, `EnvelopedVc`, `EnvelopedVp`, `DomainLinkageConfiguration`, `ClaimPath`, `TypeMetadata` and `StatusType` |
| `test-vectors` | | `keys::testsuite`, the behavioural suite every key store must pass, and `vectors`, the specification vectors |

`identity_kit::prelude` gathers the common types of the lower layer and `identity_kit::prelude::credentials` those of the upper layer, for glob import.
Expand Down
2 changes: 1 addition & 1 deletion docs/DESIGN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ All additive. CI runs `cargo hack --each-feature` and the no-default-features bu
| `domain-linkage` | on | implies `vc` and `did-web` (for `HttpClient`) |
| `linked-vp` | on | implies `vc` and `did-web` (for `HttpClient`) |
| `jwks` | off | implies `did-web` (for `HttpClient`); `JwksResolver` over JWT VC issuer metadata |
| `utoipa` | off | `utoipa`; OpenAPI schemas for `DidDocument`, `VerificationMethod`, `Service`, `Jwk`, `DomainLinkageConfiguration`, `ClaimPath` and `TypeMetadata` |
| `utoipa` | off | `utoipa`; OpenAPI schemas for `DidDocument`, `VerificationMethod`, `Service`, `Jwk`, `JwsAlgorithm`, the VCDM 1.1 and 2.0 credentials and presentations (`Credential`, `Presentation`, `CredentialV2`, `PresentationV2`, `EnvelopedVc`, `EnvelopedVp`), `DomainLinkageConfiguration`, `ClaimPath`, `TypeMetadata` and `StatusType` |
| `test-vectors` | off | nothing; `keys::testsuite` and `vectors`, the specification vectors the tests run against |

## `did` module
Expand Down
1 change: 1 addition & 0 deletions docs/FEATURES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ additive; see [`DESIGN.md`](DESIGN.md#features) for what each one pulls in.
| Feature | Status | Cargo feature | Specification | Issue |
| ------------------------------------------------------------------------------ | :----: | ------------- | -------------------------------------------- | --------------------------------------------------------- |
| OpenAPI schemas for the public types | ✅ | `utoipa` | [OpenAPI 3.1](https://spec.openapis.org/oas/v3.1.0) | [#14](https://github.com/impierce/identity-kit/issues/14) |
| OpenAPI schemas for `JwsAlgorithm` and the credentials and presentations of `vc`: `Credential`, `Presentation`, `CredentialV2`, `PresentationV2`, `EnvelopedVc`, `EnvelopedVp` | ✅ | `utoipa`, `vc` | [OpenAPI 3.1](https://spec.openapis.org/oas/v3.1.0), [VCDM 1.1][vcdm11], [VCDM 2.0][vcdm20] | [#122](https://github.com/impierce/identity-kit/issues/122) |
| Re-exported conformance vectors (`vectors`) | ✅ | `test-vectors` | | [#14](https://github.com/impierce/identity-kit/issues/14) |
| CI proof of the layer boundary (`--no-default-features --features did-key,software` builds) | ✅ | | | [#14](https://github.com/impierce/identity-kit/issues/14) |
| `cargo hack --each-feature` and `cargo publish --dry-run` in CI; `cargo-semver-checks` through release-plz | ✅ | | | [#14](https://github.com/impierce/identity-kit/issues/14) |
Expand Down
4 changes: 3 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
//!
//! - `utoipa`: OpenAPI schemas ([`utoipa::ToSchema`]) for [`DidDocument`](did::DidDocument),
//! [`VerificationMethod`](did::VerificationMethod), [`Service`](did::Service),
//! [`Jwk`](jose::Jwk), `DomainLinkageConfiguration` and `TypeMetadata`.
//! [`Jwk`](jose::Jwk), [`JwsAlgorithm`](jose::JwsAlgorithm), the credentials and
//! presentations of `vc` (VCDM 1.1 and 2.0, enveloped forms included),
//! `DomainLinkageConfiguration`, `ClaimPath`, `TypeMetadata` and `StatusType`.
//! - `test-vectors`: [`keys::testsuite`], the behavioural suite every key store must pass, and
//! [`vectors`], the specification vectors the tests of this crate run against.
#![cfg_attr(docsrs, feature(doc_cfg))]
Expand Down
Loading
Loading