Skip to content

Docs update #51

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
kieronlanning merged 2 commits into from
Sep 16, 2026
Merged

Docs update #51

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
c9d4ea4
docs: updated core documentation
kieronlanning Sep 16, 2026
74c18d3
docs: updated urls in documentation
kieronlanning Sep 16, 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
29 changes: 22 additions & 7 deletions docs/wiki/Dependency-Guardrails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ This page documents repository guardrails that prevent known dependency/runtime

### Problem

When a consumer project directly references the `Purview.EventSourcing.Validation.ZodSharp` project and uses `ZodSharp` types, relying on transitive package flow can lead to runtime assembly load failures (for example, `FileNotFoundException` for `ZodSharp`).
When a consumer project directly references the `Purview.EventSourcing.Validation.ZodSharp` project and uses `ZodSharp`
types, relying on transitive package flow can lead to runtime assembly load failures (for example,
`FileNotFoundException` for `ZodSharp`).

### Required fix in consuming project

Expand All @@ -18,7 +20,8 @@ Add a direct package reference:

### Automated enforcement

`Purview.EventSourcing.Validation.ZodSharp` includes a build target in package `buildTransitive` assets (`buildTransitive/Purview.EventSourcing.Validation.ZodSharp.targets`):
`Purview.EventSourcing.Validation.ZodSharp` includes a build target in package `buildTransitive` assets
(`buildTransitive/Purview.EventSourcing.Validation.ZodSharp.targets`):

- Target name: `ValidateZodSharpDirectReference`
- Runs: `BeforeTargets="ResolveReferences"`
Expand All @@ -31,19 +34,31 @@ This shifts failure left from runtime to build-time.

### CI verification

The reusable pack workflow also validates the generated `.nupkg` and fails if `buildTransitive/Purview.EventSourcing.Validation.ZodSharp.targets` is missing from the package contents.
The reusable pack workflow also validates the generated `.nupkg` and fails if
`buildTransitive/Purview.EventSourcing.Validation.ZodSharp.targets` is missing from the package contents.

## Validation adapters overview

- `Purview.EventSourcing.Validation.FluentValidation`: adapter for `FluentValidation.IValidator<T>` to `IAggregateValidator<T>`.
- `Purview.EventSourcing.Validation.FluentValidation`: adapter for `FluentValidation.IValidator<T>` to
`IAggregateValidator<T>`.
- `Purview.EventSourcing.Validation.ZodSharp`: adapter for `ZodSharp` schema validation to `IAggregateValidator<T>`.

When using either adapter package directly from source projects, keep direct package references explicit for external runtime dependencies used by the adapter.
When using either adapter package directly from source projects, keep direct package references explicit for external
runtime dependencies used by the adapter.

## Admin API validation and OpenAPI dependencies

`Purview.EventSourcing.Admin.API` validates its request contracts and options with ZodSharp source-generated schemas and ships the Admin API OpenAPI document (`/openapi/admin.json`) used to generate `Purview.EventSourcing.Admin.Client`. As a result `ZodSharp`, `ZodSharp.AspNetCore`, and `ZodSharp.SystemTextJson` are direct dependencies of the Admin API package.
`Purview.EventSourcing.Admin.API` validates its request contracts and options with ZodSharp source-generated schemas and
ships the Admin API OpenAPI document (`/openapi/admin.json`) used to generate `Purview.EventSourcing.Admin.Client`. As a
result `ZodSharp`, `ZodSharp.AspNetCore`, and `ZodSharp.SystemTextJson` are direct dependencies of the Admin API
package.

### OpenAPI XML-comment source generator is disabled in Admin.API

The `Microsoft.AspNetCore.OpenApi` package ships a source generator that builds a runtime cache of XML doc IDs across the compilation and its referenced assemblies. Purview's telemetry scaffolding (`Purview.Telemetry.SourceGenerator`) re-declares the same attribute types in every assembly, which makes that cache throw at runtime with a duplicate key when an OpenAPI document is generated. The Admin.API project therefore removes the `Microsoft.AspNetCore.OpenApi.SourceGenerators` analyzer from its compilation (see `Admin.API.csproj`), and the spec-export tool (`src/tools/AdminAPI.OpenAPI`) does not feed referenced assembly XML docs to the generator. The generated Admin API document and typed client remain complete; XML-comment-derived schema descriptions are omitted.
The `Microsoft.AspNetCore.OpenApi` package ships a source generator that builds a runtime cache of XML doc IDs across
the compilation and its referenced assemblies. Purview's telemetry scaffolding (`Purview.Telemetry.SourceGenerator`)
re-declares the same attribute types in every assembly, which makes that cache throw at runtime with a duplicate key
when an OpenAPI document is generated. The Admin.API project therefore removes the
`Microsoft.AspNetCore.OpenApi.SourceGenerators` analyzer from its compilation (see `Admin.API.csproj`), and the
spec-export tool (`src/tools/AdminAPI.OpenAPI`) does not feed referenced assembly XML docs to the generator. The
generated Admin API document and typed client remain complete; XML-comment-derived schema descriptions are omitted.
Loading