Enum ValueObjectJsonSchemaProfile

Namespace: AdCodicem.ValueObjects.Json
Assembly: AdCodicem.ValueObjects.Json.dll

Chooses whom a JSON Schema exported through describes a value object for.

public enum ValueObjectJsonSchemaProfile

Fields

OpenApi = 0

What the serializer reads and writes under the options, with the formats OpenAPI uses: the default.

A number the options let be read or written as text is a number or a string held to the form a number is written in, as System.Text.Json documents the number alone, and a real under lists the named literals its bounds let through. Every format the type declares is kept: int32, decimal or iban as well as uuid or date.

LanguageModel = 1

What a language model should send: the underlying type alone, with any format JSON Schema does not define moved into the description.

A number is a number, whatever the options let the serializer read, as a tool's schema describes a bare number, and its example and known values are written as numbers. A format JSON Schema defines, such as uuid, date or date-time, stays; any other, such as int32, decimal or iban, which a model or its provider may not know or may refuse, becomes a sentence of the description. A closed set lists its values in enum alone, as under the OpenAPI profile: the description does not repeat them.