json-everything

https://docs.json-everything.net
Admin
Comprehensive .NET library providing JSON utilities including validation, transformation, querying,...
Tokens:305,928
Snippets:3,730
Trust Score:7.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Complete ASP.NET Core Setup with JsonSchema Validation

Source: https://docs.json-everything.net/schema/api-validation

Complete example showing Program.cs, a request model with validation attributes, and a controller. The setup automatically rejects requests that don't match the schema before reaching controller code.

```csharp
// Program.cs
var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers()
    .AddJsonSchemaValidation(converter =>
    {
        // Configure schema evaluation options
        converter.EvaluationOptions.RequireFormatValidation = true;
    });

var app = builder.Build();
app.MapControllers();
app.Run();

// Models/CreateProductRequest.cs
[GenerateJsonSchema(PropertyNaming = NamingConvention.CamelCase)]
[AdditionalProperties(false)]
public class CreateProductRequest
{
    [Required]
    [MinLength(1)]
    [MaxLength(100)]
    public string Name { get; set; }
    
    [MinLength(10)]
    [MaxLength(500)]
    public string? Description { get; set; }
    
    [Minimum(0.01)]
    public decimal Price { get; set; }
    
    [MinItems(1)]
    [UniqueItems(true)]
    public List<string> Tags { get; set; }
}

// Controllers/ProductsController.cs
[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    [HttpPost]
    public IActionResult CreateProduct([FromBody] CreateProductRequest request)
    {
        // Fully validated request is available here
        return Ok(new { message = "Product created successfully" });
    }
}
```

--------------------------------

### Examples(this JsonSchemaBuilder builder, params JsonNode[] elements)

Source: https://docs.json-everything.net/api/JsonSchema.Net/JsonSchemaBuilderExtensions

Adds an 'examples' keyword with the specified example values.

```APIDOC
## Examples(this JsonSchemaBuilder builder, params JsonNode[] elements)

### Description
Adds an `examples` keyword with the specified example values.

### Method
Extension method

### Signature
`public static JsonSchemaBuilder Examples(this JsonSchemaBuilder builder, params JsonNode[] elements)`

### Parameters
- **builder** (JsonSchemaBuilder) - The builder.
- **elements** (params JsonNode[]) - The example values.

### Returns
The builder.
```

--------------------------------

### Examples(this JsonSchemaBuilder builder, IEnumerable<JsonNode> elements)

Source: https://docs.json-everything.net/api/JsonSchema.Net/JsonSchemaBuilderExtensions

Adds an 'examples' keyword with the specified example values.

```APIDOC
## Examples(this JsonSchemaBuilder builder, IEnumerable<JsonNode> elements)

### Description
Adds an `examples` keyword with the specified example values.

### Method
Extension method

### Signature
`public static JsonSchemaBuilder Examples(this JsonSchemaBuilder builder, IEnumerable<JsonNode> elements)`

### Parameters
- **builder** (JsonSchemaBuilder) - The builder.
- **elements** (IEnumerable<JsonNode>) - The example values.

### Returns
The builder.
```

--------------------------------

### Example(this JsonSchemaBuilder builder, JsonNode value)

Source: https://docs.json-everything.net/api/JsonSchema.Net.OpenApi/JsonSchemaBuilderExtensions

Adds an example keyword to the schema. This provides an example value for the schema.

```APIDOC
## Example(this JsonSchemaBuilder builder, JsonNode value)

### Description
Adds an `example` keyword to the schema. This provides an example value for the schema.

### Method
Extension method

### Signature
`public static JsonSchemaBuilder Example(this JsonSchemaBuilder builder, JsonNode value)`

### Parameters
- **builder** (JsonSchemaBuilder) - Required - The builder.
- **value** (JsonNode) - Required - The example value.

### Returns
The builder.
```

--------------------------------

### Example Class Properties

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/Example

The Example class exposes properties that allow users to set or retrieve example-related data, including description, external value, summary, value, and extension data.

```APIDOC
## Example Class

### Description
Models an example in OpenAPI documentation.

### Properties

#### Description
- **Type**: string
- **Summary**: Gets or sets the description.

#### ExtensionData
- **Type**: ExtensionData
- **Summary**: Gets or set extension data.

#### ExternalValue
- **Type**: string
- **Summary**: Gets or sets a URI that points to the literal example.

#### Summary
- **Type**: string
- **Summary**: Gets or sets the summary.

#### UnknownData
- **Type**: UnknownData
- **Summary**: Gets or sets properties which are not recognized by OpenAPI.

#### Value
- **Type**: JsonNode
- **Summary**: Gets or sets the example value.

### Inheritance
- **Base Type**: object

### Implemented Interfaces
- IRefTargetContainer

### Namespace
- Json.Schema.Api.OpenApi
```

--------------------------------

### To.Example(string componentName)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/To

Creates a reference to an example component.

```APIDOC
## To.Example(string componentName)

### Description
Creates a reference to an example component.

### Method
Example

### Parameters
- **componentName** (string) - Required - The key that identifies the example.

### Returns
The reference.
```

--------------------------------

### Get(string key)

Source: https://docs.json-everything.net/api/JsonSchema.Net/Formats

Gets a format by its key. Returns the specified format if known; otherwise returns null.

```APIDOC
## Get(string key)

### Description
Gets a format by its key. Returns the specified format if known; otherwise returns null.

### Method
Get

### Parameters
- **key** (string) - Required - The key.

### Returns
The specified format, if known; otherwise null.

### Declaration
```csharp
public static Format Get(string key)
```
```

--------------------------------

### Generated JSON document from example schema

Source: https://docs.json-everything.net/schema/datagen/schema-datagen

A possible JSON document generated from the example schema, containing a string property 'foo'.

```json
{
  "foo": "bar"
}
```

--------------------------------

### Schema with $defs and $ref

Source: https://docs.json-everything.net/schema/schemagen/schema-generation

Example of a schema where a common subschema is placed in $defs and referenced via $ref. This is the 'instead of' example, showing the generated schema with a $defs entry.

```json
{
  "type": "object",
  "properties": {
    "foo": { "$ref": "#/$defs/listOfString" }
  },
  "$defs": {
    "listOfString": {
      "type": "array",
      "items": { "type": "string" }
    }
  }
}
```

--------------------------------

### Example schema for data generation

Source: https://docs.json-everything.net/schema/datagen/schema-datagen

A simple JSON schema with an object type and a string property 'foo'. This is the input schema for the data generation example.

```json
{
  "type": "object",
  "properties": {
    "foo": { "type": "string" }
  }
}
```

--------------------------------

### Schema with re-integrated definition

Source: https://docs.json-everything.net/schema/schemagen/schema-generation

Example of the schema after re-integration, where the single-use definition is inlined instead of using $defs. This is the 'you'll get' example.

```json
{
  "type": "object",
  "properties": {
    "foo": {
      "type": "array",
      "items": { "type": "string" }
    }
  }
}
```

--------------------------------

### ExampleRef(Uri reference)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/ExampleRef

Initializes a new instance of the ExampleRef class with a URI reference.

```APIDOC
## ExampleRef(Uri reference)

### Description
Initializes a new instance of the ExampleRef class with a URI reference.

### Constructor
`public ExampleRef(Uri reference)`

### Parameters
- **reference** (Uri) - Required - The reference URI

```

--------------------------------

### GetStart(this SubstrRule rule)

Source: https://docs.json-everything.net/api/JsonLogic/RuleExtensions

Gets the rule that returns the start index for a SubstrRule.

```APIDOC
## GetStart(this SubstrRule rule)

### Description
Gets the rule that returns the start index.

### Method
Extension method

### Parameters
- **rule** (SubstrRule) - The rule

### Returns
A rule.
```

--------------------------------

### ExampleRef(string reference)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/ExampleRef

Initializes a new instance of the ExampleRef class with a string reference.

```APIDOC
## ExampleRef(string reference)

### Description
Initializes a new instance of the ExampleRef class with a string reference.

### Constructor
`public ExampleRef(string reference)`

### Parameters
- **reference** (string) - Required - The reference URI

```

--------------------------------

### Create BuildOptions with dialect and registries

Source: https://docs.json-everything.net/schema/basics

Shows how to instantiate BuildOptions with the Draft 2020-12 dialect and new registries for schemas, dialects, and vocabularies. All properties are optional.

```csharp
var buildOptions = new BuildOptions
{
    Dialect = Dialect.Draft202012,
    SchemaRegistry = new(),
    DialectRegistry = new(),
    VocabularyRegistry = new()
}
```

--------------------------------

### GetAttributes(this SchemaGenerationContextBase context)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Generation/ContextExtensions

Gets the attribute set for a given context. Type contexts get type attributes; member contexts get member attributes.

```APIDOC
## GetAttributes(this SchemaGenerationContextBase context)

### Description
Gets the attribute set for a given context. Type contexts get type attributes; member contexts get member attributes.

### Method
GetAttributes

### Signature
`public static IEnumerable<Attribute> GetAttributes(this SchemaGenerationContextBase context)`

### Parameters
- **context** (SchemaGenerationContextBase) - The context.

### Returns
IEnumerable<Attribute> - The attribute set.
```

--------------------------------

### Get(Uri uri)

Source: https://docs.json-everything.net/api/JsonSchema.Net/SchemaRegistry

Gets a schema by URI ID and/or anchor.

```APIDOC
## Get(Uri uri)

### Description
Gets a schema by URI ID and/or anchor.

### Method
Get

### Signature
public IBaseDocument Get(Uri uri)

### Parameters
- **uri** (Uri) - Required - The URI ID.

### Returns
The schema, if registered in either this or the global registry; otherwise null.
```

--------------------------------

### Server(string url)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/Server

Initializes a new instance of the Server class with the specified server URL.

```APIDOC
## Server(string url)

### Description
Initializes a new instance of the Server class with the specified server URL.

### Constructor
Server(string url)

### Parameters
- **url** (string) - Required - The server URL.

```

--------------------------------

### Get the parent of a JSON Pointer with GetParent()

Source: https://docs.json-everything.net/pointer/basics

Gets the immediate parent pointer using the GetParent() method.

```csharp
var pointer = JsonPointer.Parse("/objects/and/3/arrays");
var parent = pointer.GetParent();  // /objects/and/3
```

--------------------------------

### Basic bundling example with SchemaRegistry.CreateBundle()

Source: https://docs.json-everything.net/schema/bundling

Creates two JSON schemas (person and address) and bundles them using SchemaRegistry.Global.CreateBundle(). The root schema references the address schema. The method returns null if the root schema is not found, and throws NotSupportedException for dynamic/recursive references.

```csharp
var bundled = SchemaRegistry.Global.CreateBundle(
    new Uri("https://schemas.example.com/person"),
    new Uri("https://schemas.example.com/person.bundle")
);

if (bundled is null)
    throw new InvalidOperationException("Root schema was not found.");
```

--------------------------------

### Write OpenAPI Description to disk with FileOutputPath

Source: https://docs.json-everything.net/schema/api-openapi

Configure AddOpenApi to write the OpenAPI Description to disk at application startup. FileOutputPath carries no extension; one file is written per format in DocumentFormats. With default formats, this writes docs/openapi.json and docs/openapi.yaml. The directory is created if it does not exist.

```csharp
builder.Services.AddOpenApi(c =>
{
    c.FileOutputPath = "docs/openapi";
});
```

--------------------------------

### Get a local JSON Pointer with GetLocal()

Source: https://docs.json-everything.net/pointer/basics

Gets a local pointer relative to a given segment index using the GetLocal() method.

```csharp
var pointer = JsonPointer.Parse("/objects/and/3/arrays");
var local = pointer.GetLocal(2);  // /3/arrays
```

--------------------------------

### FromFile(string fileName, BuildOptions options, Uri baseUri)

Source: https://docs.json-everything.net/api/JsonSchema.Net/JsonSchema

Loads text from a file and builds a JsonSchema instance.

```APIDOC
## FromFile(string fileName, BuildOptions options, Uri baseUri)

### Description
Loads text from a file and builds a JsonSchema instance.

### Method
FromFile

### Signature
public static JsonSchema FromFile(string fileName, BuildOptions options, Uri baseUri)

### Parameters
- **fileName** (string) - Required - The filename to load, URL-decoded.
- **options** (BuildOptions) - Optional - Serializer options.
- **baseUri** (Uri) - Optional - The base URI for this schema.

### Returns
A new JsonSchema instance.

### Remarks
The filename needs to not be URL-encoded as System.Uri attempts to encode it.
```

--------------------------------

### Get(Uri uri)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Data/DataRegistry

Gets data by URI ID. Returns the JSON element if registered in either this or the global registry; otherwise null.

```APIDOC
## Get(Uri uri)

### Description
Gets data by URI ID.

### Method
Get

### Signature
public JsonElement? Get(Uri uri)

### Parameters
- **uri** (Uri) - The URI ID.

### Returns
The **System.Text.Json.JsonElement**, if registered in either this or the global registry; otherwise null.
```

--------------------------------

### Initialize(SchemaRegistry, JsonSerializerOptions)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/OpenApiDocument

Initializes the document model with optional schema registry and serializer options.

```APIDOC
## Method

### Initialize(SchemaRegistry schemaRegistry, JsonSerializerOptions options)

#### Description
Initializes the document model.

#### Parameters
- **schemaRegistry** (SchemaRegistry) - Optional - A schema registry.
- **options** (JsonSerializerOptions) - Optional - Serializer options.

#### Returns
A Task representing the asynchronous operation.

#### Declaration
```csharp
public Task Initialize(SchemaRegistry schemaRegistry, JsonSerializerOptions options)
```
```

--------------------------------

### Set up automatic schema download with Fetch

Source: https://docs.json-everything.net/schema/examples/external-schemas

Sets up automatic downloading of external schemas by assigning a Fetch function to the global schema registry. The function downloads the schema content and parses it; returns null on failure. Automatically downloading external data is discouraged by the specification and disabled by default.

```csharp
JsonSchema? DownloadSchema(Uri uri)
{
    try
    {
        var content = new HttpClient().GetStringAsync(uri).Result;
        return JsonSchema.FromText(content);
    }
    catch (Exception e)
    {
        return null;
    } 
}

SchemaRegistry.Global.Fetch = DownloadSchema;

```

--------------------------------

### LicenseInfo Constructor

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/LicenseInfo

Initializes a new instance of the LicenseInfo class with the specified license name.

```APIDOC
## LicenseInfo Constructor

### Description
Initializes a new instance of the LicenseInfo class with the specified license name.

### Declaration
```csharp
public LicenseInfo(string name)
```

### Parameters
- **name** (string) - Required - The license name used for the API.

```

--------------------------------

### Register(BuildOptions buildOptions)

Source: https://docs.json-everything.net/api/JsonSchema.Net.OpenApi/MetaSchemas

Registers all components required to use the OpenAPI vocabulary. This method is static and intended for application-wide setup.

```APIDOC
## Register(BuildOptions buildOptions)

### Description
Registers all components required to use the OpenAPI vocabulary.

### Method
Register

### Signature
public static void Register(BuildOptions buildOptions)

### Parameters
- **buildOptions** (BuildOptions) - Required - The build options used for registration.

### Return Value
void

```

--------------------------------

### Get(Type type)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Generation/SchemaGenerationContextCache

Gets or creates a TypeGenerationContext based on the given type and attribute set. Returns a cached context if one exists, otherwise creates and caches a new one.

```APIDOC
## Get(Type type)

### Description
Gets or creates a **Json.Schema.Generation.TypeGenerationContext** based on the given type and attribute set. Returns a generation context from the cache if one exists with the specified type and attribute set; otherwise a new one is created and automatically cached.

### Method
Get

### Endpoint
SchemaGenerationContextCache.Get(Type type)

### Parameters
#### Parameters
- **type** (Type) - Required - The type to generate.

### Returns
A generation context, from the cache if one exists with the specified type and attribute set; otherwise a new one. New contexts are automatically cached.

### Remarks
Use this in your generator if it needs to create keywords with subschemas.

### Declaration
```csharp
public static TypeGenerationContext Get(Type type)
```
```

--------------------------------

### Custom converter using options.GetConverter (recommended)

Source: https://docs.json-everything.net/more/json-more

Shows the recommended approach of getting the converter via options.GetConverter and invoking it directly to preserve error information.

```csharp
class MyJsonConverter : JsonConverter<MyClass>
{
    public override MyClass Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        var result = new MyClass();
        // ...
        var fooConverter = (JsonConverter<Foo>)options.GetConverter(typeof(Foo));
        result.Foo = fooConverter.Read(ref reader, typeof(Foo), options);
        // ...
        return result;
    } 
}
```

--------------------------------

### GetComplement()

Source: https://docs.json-everything.net/api/JsonSchema.Net.DataGeneration/NumberRangeSet

Gets the complement, or inversion, of the set.

```APIDOC
## Method: GetComplement()

### Description
Gets the complement, or inversion, of the set.

### Declaration
```csharp
public NumberRangeSet GetComplement()
```

### Returns
The complement of the set.
```

--------------------------------

### Configure OpenAPI options with AddOpenApi delegate

Source: https://docs.json-everything.net/schema/api-openapi

Configures the OpenAPI options via the delegate passed to AddOpenApi(). The OpenAPI Description is served only when DocumentPath has a value, the reference page only when InteractivePath does, and a file is written only when FileOutputPath does. Set a path to null to turn that piece off.

```csharp
builder.Services.AddOpenApi(c =>
{
    c.Document.Info.Title = "Pet Store";
    c.Document.Info.Description = "The pet store API.";
    c.DocumentPath = "/openapi";
    c.InteractivePath = "/openapi/reference";
});
```

--------------------------------

### WriteOnlyKeyword.Name

Source: https://docs.json-everything.net/api/JsonSchema.Net/WriteOnlyKeyword

Gets the name of the handled keyword.

```APIDOC
## Property: Name

### Description
Gets the name of the handled keyword.

### Property Type
string

### Access
Read-only

### Example
```csharp
string keywordName = WriteOnlyKeyword.Instance.Name;
```
```

--------------------------------

### Use options.Write extension for AOT-compatible serialization

Source: https://docs.json-everything.net/more/json-more

Rewrites the previous example using the options.Write extension, which passes the options to the converter.

```csharp
options.Write(writer, value, MySerializerContext.Default.MyValue);
```

--------------------------------

### SchemaKeyword.Name

Source: https://docs.json-everything.net/api/JsonSchema.Net/SchemaKeyword

Gets the name of the handled keyword.

```APIDOC
## SchemaKeyword.Name

### Description
Gets the name of the handled keyword.

### Property
- **Name** (string) - Gets the name of the handled keyword.
```

--------------------------------

### DependentSchemasKeyword.Name

Source: https://docs.json-everything.net/api/JsonSchema.Net/DependentSchemasKeyword

Gets the name of the handled keyword.

```APIDOC
## Property: Name

### Description
Gets the name of the handled keyword.

### Type
string

### Access
Read-only

### Example
```csharp
string name = DependentSchemasKeyword.Instance.Name;
```
```

--------------------------------

### OpenApiInfo Constructor

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/OpenApiInfo

Initializes a new instance of the OpenApiInfo class with the specified title and version.

```APIDOC
## OpenApiInfo Constructor

### Description
Initializes a new instance of the OpenApiInfo class with the specified title and version.

### Declaration
```csharp
public OpenApiInfo(string title, string version)
```

### Parameters
- **title** (string) - Required - The title.
- **version** (string) - Required - The API version.

```

--------------------------------

### With(this Dialect dialect, IEnumerable<IKeywordHandler> add, Uri id, bool? refIgnoresSiblingKeywords, bool? allowUnknownKeywords)

Source: https://docs.json-everything.net/api/JsonSchema.Net/DialectExtensions

Creates a new Dialect instance by extending the specified dialect with additional keyword handlers and optional configuration overrides.

```APIDOC
## With(this Dialect dialect, IEnumerable<IKeywordHandler> add, Uri id, bool? refIgnoresSiblingKeywords, bool? allowUnknownKeywords)

### Description
Creates a new Dialect instance by extending the specified dialect with additional keyword handlers and optional configuration overrides.

### Method
With

### Signature
public static Dialect With(this Dialect dialect, IEnumerable<IKeywordHandler> add, Uri id, bool? refIgnoresSiblingKeywords, bool? allowUnknownKeywords)

### Parameters
- **dialect** (Dialect) - Required - The base Dialect to extend. Cannot be null.
- **add** (IEnumerable<IKeywordHandler>) - Required - A collection of keyword handlers to add to the new Dialect. Cannot be null.
- **id** (Uri) - Optional - An optional identifier for the new Dialect. If null, the identifier from the base dialect is used.
- **refIgnoresSiblingKeywords** (bool?) - Optional - An optional value indicating whether '$ref' keywords ignore sibling keywords. If null, the value from the base dialect is used.
- **allowUnknownKeywords** (bool?) - Optional - An optional value indicating whether unknown keywords are allowed. If null, the value from the base dialect is used.

### Returns
A new Dialect instance containing the combined keyword handlers and configuration settings.

### Remarks
This method is useful for creating customized dialects based on an existing one, allowing selective extension.
```

--------------------------------

### DependentRequiredKeyword.Name

Source: https://docs.json-everything.net/api/JsonSchema.Net/DependentRequiredKeyword

Gets the name of the handled keyword.

```APIDOC
## Property: Name

### Description
Gets the name of the handled keyword.

### Property Signature
`public string Name { get; }`

### Returns
- **string** - The name of the keyword.
```

--------------------------------

### ToString()

Source: https://docs.json-everything.net/api/JsonPointer.Net/JsonPointer

Gets the string representation of this pointer.

```APIDOC
## ToString()

### Description
Gets the string representation of this pointer.

### Method
ToString (override)

### Signature
public override string ToString()

### Returns
The pointer string.
```

--------------------------------

### Format(string key)

Source: https://docs.json-everything.net/api/JsonSchema.Net/Format

Creates a new Format instance with a specified key.

```APIDOC
## Format(string key)

### Description
Creates a new Json.Schema.Format instance with the specified format key.

### Constructor
`public Format(string key)`

### Parameters
- **key** (string) - Required - The format key.

```

--------------------------------

### WriteOnlyKeyword.Instance

Source: https://docs.json-everything.net/api/JsonSchema.Net/WriteOnlyKeyword

Gets the singleton instance of the WriteOnlyKeyword class.

```APIDOC
## Property: Instance

### Description
Gets the singleton instance of the **Json.Schema.Keywords.WriteOnlyKeyword**.

### Property Type
WriteOnlyKeyword

### Access
Read-only

### Example
```csharp
var instance = WriteOnlyKeyword.Instance;
```
```

--------------------------------

### DescriptionIntent Constructor

Source: https://docs.json-everything.net/api/JsonSchema.Net.Generation/DescriptionIntent

Creates a new DescriptionIntent instance with a string value for the description.

```APIDOC
## DescriptionIntent(string value)

### Description
Creates a new **Json.Schema.Generation.Intents.DescriptionIntent** instance.

### Constructor
`public DescriptionIntent(string value)`

### Parameters
- **value** (string) - The value.

### Example
csharp
var intent = new DescriptionIntent("A description");

```

--------------------------------

### SchemaKeyword.Instance

Source: https://docs.json-everything.net/api/JsonSchema.Net/SchemaKeyword

Gets the singleton instance of the SchemaKeyword class.

```APIDOC
## SchemaKeyword.Instance

### Description
Gets the singleton instance of the SchemaKeyword class.

### Property
- **Instance** (SchemaKeyword) - Gets the singleton instance of the SchemaKeyword class.
```

--------------------------------

### Example evaluation output with details

Source: https://docs.json-everything.net/schema/basics

Shows the output of an evaluation with detailed output format, including validation errors for properties foo and bar.

```json
{
  "valid": false,
  "details": [
    {
      "valid": false,
      "evaluationPath": "/properties/foo/allOf/0",
      "schemaLocation": "https://json-schema.org/schemas/example#/properties/foo/allOf/0",
      "instanceLocation": "/foo",
      "errors": {
        "required": "Required properties [\"unspecified-prop\"] were not present"
      }
    },
    {
      "valid": false,
      "evaluationPath": "/properties/foo/allOf/1/properties/foo-prop",
      "schemaLocation": "https://json-schema.org/schemas/example#/properties/foo/allOf/1/properties/foo-prop",
      "instanceLocation": "/foo/foo-prop",
      "errors": {
        "const": "Expected \"1\""
      }
    },
    {
      "valid": false,
      "evaluationPath": "/properties/bar/$ref/properties/bar-prop",
      "schemaLocation": "https://json-schema.org/schemas/example#/$defs/bar/properties/bar-prop",
      "instanceLocation": "/bar/bar-prop",
      "errors": {
        "minimum": "2 is less than or equal to 10"
      }
    }
  ]
}
```

--------------------------------

### MaxItemsKeyword.Name

Source: https://docs.json-everything.net/api/JsonSchema.Net/MaxItemsKeyword

Gets the name of the handled keyword, which is 'maxItems'.

```APIDOC
## MaxItemsKeyword.Name

### Description
Gets the name of the handled keyword.

### Property
- **Name** (string) - Gets the name of the handled keyword.
```

--------------------------------

### Build schema with prefixItems and evaluate with Draft 2020-12

Source: https://docs.json-everything.net/schema/examples/version-selection

Builds a JSON Schema using prefixItems and items, then evaluates an instance with EvaluationOptions.EvaluateAs set to Draft.Draft202012. The evaluation succeeds because prefixItems is supported in draft 2020-12.

```csharp
var schemaJson = JsonDocument.Parse(
    """
    {
      "type": "array",
      "prefixItems": [
        { "type": "integer" },
        { "type": "boolean" }
      ],
      "items": { "type": "string" }
    }
    """).RootElement;
JsonSchema schema = JsonSchema.Build(schemaJson);

var instance = JsonDocument.Parse("""[1, true, "foo", "bar"]""").RootElement;
```

```csharp
var options = new EvaluationOptions{
    EvaluateAs = Draft.Draft202012
};

var results = schema.Evaluate(instance, options); // results.IsValid == true
```

--------------------------------

### Response(string description)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/Response

Initializes a new instance of the Response class with the specified description.

```APIDOC
## Response(string description)

### Description
Initializes a new instance of the Response class with the specified description.

### Constructor
`public Response(string description)`

### Parameters
- **description** (string) - Required - The description.

```

--------------------------------

### MaxItemsKeyword.Instance

Source: https://docs.json-everything.net/api/JsonSchema.Net/MaxItemsKeyword

Gets the singleton instance of the MaxItemsKeyword class.

```APIDOC
## MaxItemsKeyword.Instance

### Description
Gets the singleton instance of the MaxItemsKeyword class.

### Property
- **Instance** (MaxItemsKeyword) - Gets the singleton instance of the MaxItemsKeyword class.

### Remarks
This property provides access to the shared instance of the MaxItemsKeyword handler.
```

--------------------------------

### Build(BuildOptions options, Uri baseUri)

Source: https://docs.json-everything.net/api/JsonSchema.Net/JsonSchemaBuilder

Builds a JSON schema from the configured keywords and returns a corresponding Json.Schema.JsonSchema instance.

```APIDOC
## Method: Build(BuildOptions options, Uri baseUri)

### Description
Builds a JSON schema from the configured keywords and returns a corresponding Json.Schema.JsonSchema instance.

### Declaration
```csharp
public JsonSchema Build(BuildOptions options, Uri baseUri)
```

### Parameters
- **options** (BuildOptions) - Optional - Build options that control schema generation behavior. Overrides build options.
- **baseUri** (Uri) - Optional - A base URI to associate with the generated schema. If specified, it is used to resolve relative references.

### Returns
A Json.Schema.JsonSchema instance representing the constructed schema based on the provided options and base URI.
```

--------------------------------

### ExclusiveMinimumKeyword.Instance

Source: https://docs.json-everything.net/api/JsonSchema.Net/ExclusiveMinimumKeyword

Gets the singleton instance of the ExclusiveMinimumKeyword class.

```APIDOC
## Property: Instance

### Description
Gets the singleton instance of the **Json.Schema.Keywords.ExclusiveMinimumKeyword**.

### Property Signature
`public ExclusiveMinimumKeyword Instance { get; }`

### Returns
- **ExclusiveMinimumKeyword** - The singleton instance of the class.
```

--------------------------------

### DependentSchemasKeyword.Instance

Source: https://docs.json-everything.net/api/JsonSchema.Net/DependentSchemasKeyword

Gets the singleton instance of the DependentSchemasKeyword class.

```APIDOC
## Property: Instance

### Description
Gets the singleton instance of the **Json.Schema.Keywords.DependentSchemasKeyword**.

### Type
DependentSchemasKeyword

### Access
Read-only

### Example
```csharp
var instance = DependentSchemasKeyword.Instance;
```
```

--------------------------------

### To.Schema(string componentName)

Source: https://docs.json-everything.net/api/JsonSchema.Net.Api/To

Creates a reference to a schema component.

```APIDOC
## To.Schema(string componentName)

### Description
Creates a reference to a schema component.

### Method
Schema

### Parameters
- **componentName** (string) - Required - The key that identifies the schema.

### Returns
The reference.
```

--------------------------------

### DependentRequiredKeyword.Instance

Source: https://docs.json-everything.net/api/JsonSchema.Net/DependentRequiredKeyword

Gets the singleton instance of the DependentRequiredKeyword class.

```APIDOC
## Property: Instance

### Description
Gets the singleton instance of the **Json.Schema.Keywords.DependentRequiredKeyword**.

### Property Signature
`public static DependentRequiredKeyword Instance { get; }`

### Returns
- **DependentRequiredKeyword** - The singleton instance.
```

--------------------------------

### ContentEncodingKeyword.Name

Source: https://docs.json-everything.net/api/JsonSchema.Net/ContentEncodingKeyword

Gets the name of the handled keyword, which is 'contentEncoding'.

```APIDOC
## ContentEncodingKeyword.Name

### Description
Gets the name of the handled keyword.

### Property
- **Type**: string
- **Access**: public

### Remarks
The name is used to identify the keyword in JSON Schema processing.

```

--------------------------------

### ContentEncodingKeyword.Instance

Source: https://docs.json-everything.net/api/JsonSchema.Net/ContentEncodingKeyword

Gets the singleton instance of the ContentEncodingKeyword class.

```APIDOC
## ContentEncodingKeyword.Instance

### Description
Gets the singleton instance of the ContentEncodingKeyword class.

### Property
- **Type**: ContentEncodingKeyword
- **Access**: public static

### Remarks
This property provides a shared instance for use in keyword handling.

```

--------------------------------

### TryGet(string name, out IPathFunctionDefinition function)

Source: https://docs.json-everything.net/api/JsonPath.Net/FunctionRepository

Gets a function implementation by name.

```APIDOC
## TryGet(string name, out IPathFunctionDefinition function)

### Description
Gets a function implementation by name.

### Method
TryGet

### Parameters
- **name** (string) - Required - A function name.
- **function** (out IPathFunctionDefinition) - Required - The function, if found; otherwise null.

### Returns
True if found; otherwise false.

### Declaration
```csharp
public static bool TryGet(string name, out IPathFunctionDefinition function)
```
```
Tokens:
Raw