Class ValueObjectSchemaTransformer

Namespace: AdCodicem.ValueObjects.OpenApi
Assembly: AdCodicem.ValueObjects.OpenApi.dll

Documents a value object as its underlying type rather than as an object with a Value property.

public sealed class ValueObjectSchemaTransformer : IOpenApiSchemaTransformer

Inheritance

object ← ValueObjectSchemaTransformer

Implements

IOpenApiSchemaTransformer

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Remarks

Schema generation is driven by JsonTypeInfo, and a type carrying a custom converter is opaque to it, so a value object would otherwise appear as an empty schema. This transformer fills it in from the the generator captured, which means the pattern, bounds, length and accepted values published in the document are literally the ones the type enforces — they cannot drift.

A value object written by hand is documented as well, from its annotation, through the descriptor the registry builds by reflection when nothing registered the type, as the model binder and the FluentValidation rules resolve it. It runs while the document is built, not per request.

A value object over a number honours as the built-in converter of its underlying type does, and is documented as System.Text.Json documents that type under the same options: as a number or a string matching a numeric pattern when a number may be written or read as text, and, over a or a , with the named literals its bounds let through.

Methods

TransformAsync(OpenApiSchema, OpenApiSchemaTransformerContext, CancellationToken)

Transforms the specified OpenAPI schema.

public Task TransformAsync(OpenApiSchema schema, OpenApiSchemaTransformerContext context, CancellationToken cancellationToken)

Parameters

schema OpenApiSchema

The to modify.

context OpenApiSchemaTransformerContext

The associated with the .

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task

The task object representing the asynchronous operation.