Class FluentBuilderExtensions

Extends JsonSchema to aid in construction.

Inheritance
System.Object
FluentBuilderExtensions
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Manatee.Json.Schema
Assembly: Manatee.Json.dll
Syntax
public static class FluentBuilderExtensions

Methods

| Improve this Doc View Source

AdditionalItems(JsonSchema, JsonSchema)

Add an additionalItems keyword to the schema.

Declaration
public static JsonSchema AdditionalItems(this JsonSchema schema, JsonSchema additionalItems)
Parameters
Type Name Description
JsonSchema schema
JsonSchema additionalItems
Returns
Type Description
JsonSchema
| Improve this Doc View Source

AdditionalProperties(JsonSchema, JsonSchema)

Add an additionalProperties keyword to the schema.

Declaration
public static JsonSchema AdditionalProperties(this JsonSchema schema, JsonSchema otherSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema otherSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

AllOf(JsonSchema, JsonSchema[])

Add an allOf keyword to the schema.

Declaration
public static JsonSchema AllOf(this JsonSchema schema, params JsonSchema[] definitions)
Parameters
Type Name Description
JsonSchema schema
JsonSchema[] definitions
Returns
Type Description
JsonSchema
| Improve this Doc View Source

AnyOf(JsonSchema, JsonSchema[])

Add an anyOf keyword to the schema.

Declaration
public static JsonSchema AnyOf(this JsonSchema schema, params JsonSchema[] definitions)
Parameters
Type Name Description
JsonSchema schema
JsonSchema[] definitions
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Comment(JsonSchema, String)

Add a $comment keyword to the schema.

Declaration
public static JsonSchema Comment(this JsonSchema schema, string comment)
Parameters
Type Name Description
JsonSchema schema
System.String comment
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Const(JsonSchema, JsonValue)

Add a const keyword to the schema.

Declaration
public static JsonSchema Const(this JsonSchema schema, JsonValue value)
Parameters
Type Name Description
JsonSchema schema
JsonValue value
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Contains(JsonSchema, JsonSchema)

Add a contains keyword to the schema.

Declaration
public static JsonSchema Contains(this JsonSchema schema, JsonSchema match)
Parameters
Type Name Description
JsonSchema schema
JsonSchema match
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ContentEncoding(JsonSchema, String)

Add a contentEncoding keyword to the schema.

Declaration
public static JsonSchema ContentEncoding(this JsonSchema schema, string encoding)
Parameters
Type Name Description
JsonSchema schema
System.String encoding
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ContentMediaType(JsonSchema, String)

Add a contentMediaType keyword to the schema.

Declaration
public static JsonSchema ContentMediaType(this JsonSchema schema, string mediaType)
Parameters
Type Name Description
JsonSchema schema
System.String mediaType
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ContentSchema(JsonSchema, JsonSchema)

Add a contentSchema keyword to the schema.

Declaration
public static JsonSchema ContentSchema(this JsonSchema schema, JsonSchema match)
Parameters
Type Name Description
JsonSchema schema
JsonSchema match
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Def(JsonSchema, String, JsonSchema)

Add a single definition to the $def keyword.

Declaration
public static JsonSchema Def(this JsonSchema schema, string name, JsonSchema definition)
Parameters
Type Name Description
JsonSchema schema
System.String name
JsonSchema definition
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Default(JsonSchema, JsonValue)

Add a default keyword to the schema.

Declaration
public static JsonSchema Default(this JsonSchema schema, JsonValue value)
Parameters
Type Name Description
JsonSchema schema
JsonValue value
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Definition(JsonSchema, String, JsonSchema)

Add a single definition to the definitions keyword.

Declaration
public static JsonSchema Definition(this JsonSchema schema, string name, JsonSchema definition)
Parameters
Type Name Description
JsonSchema schema
System.String name
JsonSchema definition
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Dependency(JsonSchema, String, JsonSchema)

Add a schema-based dependency to the dependencies keyword.

Declaration
public static JsonSchema Dependency(this JsonSchema schema, string name, JsonSchema dependency)
Parameters
Type Name Description
JsonSchema schema
System.String name
JsonSchema dependency
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Dependency(JsonSchema, String, String[])

Add a property-based dependency to the dependencies keyword.

Declaration
public static JsonSchema Dependency(this JsonSchema schema, string name, params string[] dependencies)
Parameters
Type Name Description
JsonSchema schema
System.String name
System.String[] dependencies
Returns
Type Description
JsonSchema
| Improve this Doc View Source

DependentRequired(JsonSchema, String, String[])

Add a property-based dependency to the dependencies keyword.

Declaration
public static JsonSchema DependentRequired(this JsonSchema schema, string name, params string[] dependencies)
Parameters
Type Name Description
JsonSchema schema
System.String name
System.String[] dependencies
Returns
Type Description
JsonSchema
| Improve this Doc View Source

DependentSchema(JsonSchema, String, JsonSchema)

Add a schema-based dependency to the dependencies keyword.

Declaration
public static JsonSchema DependentSchema(this JsonSchema schema, string name, JsonSchema dependency)
Parameters
Type Name Description
JsonSchema schema
System.String name
JsonSchema dependency
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Description(JsonSchema, String)

Add a descriptions keyword to the schema.

Declaration
public static JsonSchema Description(this JsonSchema schema, string description)
Parameters
Type Name Description
JsonSchema schema
System.String description
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Else(JsonSchema, JsonSchema)

Add an else keyword to the schema.

Declaration
public static JsonSchema Else(this JsonSchema schema, JsonSchema elseSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema elseSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Enum(JsonSchema, JsonValue[])

Add an enum keyword to the schema.

Declaration
public static JsonSchema Enum(this JsonSchema schema, params JsonValue[] values)
Parameters
Type Name Description
JsonSchema schema
JsonValue[] values
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Examples(JsonSchema, JsonValue[])

Add an examples keyword to the schema.

Declaration
public static JsonSchema Examples(this JsonSchema schema, params JsonValue[] value)
Parameters
Type Name Description
JsonSchema schema
JsonValue[] value
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ExclusiveMaximum(JsonSchema, Double)

Add an exclusiveMaximum keyword to the schema.

Declaration
public static JsonSchema ExclusiveMaximum(this JsonSchema schema, double maximum)
Parameters
Type Name Description
JsonSchema schema
System.Double maximum
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ExclusiveMaximumDraft04(JsonSchema, Boolean)

Add an exclusiveMaximum keyword for draft-04 to the schema.

Declaration
public static JsonSchema ExclusiveMaximumDraft04(this JsonSchema schema, bool isExclusive)
Parameters
Type Name Description
JsonSchema schema
System.Boolean isExclusive
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ExclusiveMinimum(JsonSchema, Double)

Add an exclusiveMinimum keyword to the schema.

Declaration
public static JsonSchema ExclusiveMinimum(this JsonSchema schema, double minimum)
Parameters
Type Name Description
JsonSchema schema
System.Double minimum
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ExclusiveMinimumDraft04(JsonSchema, Boolean)

Add an exclusiveMinimum keyword for draft-04 to the schema.

Declaration
public static JsonSchema ExclusiveMinimumDraft04(this JsonSchema schema, bool isExclusive)
Parameters
Type Name Description
JsonSchema schema
System.Boolean isExclusive
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Format(JsonSchema, IFormatValidator)

Add a format keyword to the schema.

Declaration
public static JsonSchema Format(this JsonSchema schema, IFormatValidator format)
Parameters
Type Name Description
JsonSchema schema
IFormatValidator format
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Format(JsonSchema, String)

Add a format keyword to the schema.

Declaration
public static JsonSchema Format(this JsonSchema schema, string format)
Parameters
Type Name Description
JsonSchema schema
System.String format
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Id(JsonSchema, String)

Add an $id keyword to the schema.

Declaration
public static JsonSchema Id(this JsonSchema schema, string id)
Parameters
Type Name Description
JsonSchema schema
System.String id
Returns
Type Description
JsonSchema
| Improve this Doc View Source

IdDraft04(JsonSchema, String)

Add an id keyword for draft-04 to the schema.

Declaration
public static JsonSchema IdDraft04(this JsonSchema schema, string id)
Parameters
Type Name Description
JsonSchema schema
System.String id
Returns
Type Description
JsonSchema
| Improve this Doc View Source

If(JsonSchema, JsonSchema)

Add an if keyword to the schema.

Declaration
public static JsonSchema If(this JsonSchema schema, JsonSchema ifSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema ifSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Item(JsonSchema, JsonSchema)

Add an items keyword to the schema.

Declaration
public static JsonSchema Item(this JsonSchema schema, JsonSchema definition)
Parameters
Type Name Description
JsonSchema schema
JsonSchema definition
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Items(JsonSchema, JsonSchema)

Add an items keyword to the schema.

Declaration
public static JsonSchema Items(this JsonSchema schema, JsonSchema definition)
Parameters
Type Name Description
JsonSchema schema
JsonSchema definition
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MaxContains(JsonSchema, UInt32)

Add a maxContains keyword to the schema.

Declaration
public static JsonSchema MaxContains(this JsonSchema schema, uint count)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 count
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Maximum(JsonSchema, Double)

Add a maximum keyword to the schema.

Declaration
public static JsonSchema Maximum(this JsonSchema schema, double maximum)
Parameters
Type Name Description
JsonSchema schema
System.Double maximum
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MaxItems(JsonSchema, UInt32)

Add a maxItems keyword to the schema.

Declaration
public static JsonSchema MaxItems(this JsonSchema schema, uint count)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 count
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MaxLength(JsonSchema, UInt32)

Add a maxLength keyword to the schema.

Declaration
public static JsonSchema MaxLength(this JsonSchema schema, uint length)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 length
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MaxProperties(JsonSchema, UInt32)

Add a maxProperties keyword to the schema.

Declaration
public static JsonSchema MaxProperties(this JsonSchema schema, uint count)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 count
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MinContains(JsonSchema, UInt32)

Add a minContains keyword to the schema.

Declaration
public static JsonSchema MinContains(this JsonSchema schema, uint count)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 count
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Minimum(JsonSchema, Double)

Add a minimum keyword to the schema.

Declaration
public static JsonSchema Minimum(this JsonSchema schema, double minimum)
Parameters
Type Name Description
JsonSchema schema
System.Double minimum
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MinItems(JsonSchema, UInt32)

Add a minItems keyword to the schema.

Declaration
public static JsonSchema MinItems(this JsonSchema schema, uint count)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 count
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MinLength(JsonSchema, UInt32)

Add a minLength keyword to the schema.

Declaration
public static JsonSchema MinLength(this JsonSchema schema, uint length)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 length
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MinProperties(JsonSchema, UInt32)

Add a minProperties keyword to the schema.

Declaration
public static JsonSchema MinProperties(this JsonSchema schema, uint count)
Parameters
Type Name Description
JsonSchema schema
System.UInt32 count
Returns
Type Description
JsonSchema
| Improve this Doc View Source

MultipleOf(JsonSchema, Double)

Add a multipleOf keyword to the schema.

Declaration
public static JsonSchema MultipleOf(this JsonSchema schema, double divisor)
Parameters
Type Name Description
JsonSchema schema
System.Double divisor
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Not(JsonSchema, JsonSchema)

Add a not keyword to the schema.

Declaration
public static JsonSchema Not(this JsonSchema schema, JsonSchema notSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema notSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

OneOf(JsonSchema, JsonSchema[])

Add a oneOf keyword to the schema.

Declaration
public static JsonSchema OneOf(this JsonSchema schema, params JsonSchema[] definitions)
Parameters
Type Name Description
JsonSchema schema
JsonSchema[] definitions
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Pattern(JsonSchema, String)

Add a pattern keyword to the schema.

Declaration
public static JsonSchema Pattern(this JsonSchema schema, string pattern)
Parameters
Type Name Description
JsonSchema schema
System.String pattern
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Pattern(JsonSchema, Regex)

Add a pattern keyword to the schema.

Declaration
public static JsonSchema Pattern(this JsonSchema schema, Regex pattern)
Parameters
Type Name Description
JsonSchema schema
System.Text.RegularExpressions.Regex pattern
Returns
Type Description
JsonSchema
| Improve this Doc View Source

PatternProperty(JsonSchema, String, JsonSchema)

Add a single pattern-based property requirement to the patterProperties keyword.

Declaration
public static JsonSchema PatternProperty(this JsonSchema schema, string name, JsonSchema property)
Parameters
Type Name Description
JsonSchema schema
System.String name
JsonSchema property
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Property(JsonSchema, String, JsonSchema)

Add a single property requirement to the properties keyword.

Declaration
public static JsonSchema Property(this JsonSchema schema, string name, JsonSchema property)
Parameters
Type Name Description
JsonSchema schema
System.String name
JsonSchema property
Returns
Type Description
JsonSchema
| Improve this Doc View Source

PropertyNames(JsonSchema, JsonSchema)

Add a propertyNames keyword to the schema.

Declaration
public static JsonSchema PropertyNames(this JsonSchema schema, JsonSchema otherSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema otherSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

ReadOnly(JsonSchema, Boolean)

Add a readOnly keyword to the schema.

Declaration
public static JsonSchema ReadOnly(this JsonSchema schema, bool isReadOnly)
Parameters
Type Name Description
JsonSchema schema
System.Boolean isReadOnly
Returns
Type Description
JsonSchema
| Improve this Doc View Source

RecursiveAnchor(JsonSchema, Boolean)

Add a $recursiveAnchor keyword to the schema. The only supported value is true.

Declaration
public static JsonSchema RecursiveAnchor(this JsonSchema schema, bool value)
Parameters
Type Name Description
JsonSchema schema
System.Boolean value
Returns
Type Description
JsonSchema
| Improve this Doc View Source

RecursiveRef(JsonSchema, String)

Add a $recursiveRef keyword to the schema.

Declaration
public static JsonSchema RecursiveRef(this JsonSchema schema, string reference)
Parameters
Type Name Description
JsonSchema schema
System.String reference
Returns
Type Description
JsonSchema
| Improve this Doc View Source

RecursiveRefRoot(JsonSchema)

Add a $recursiveRef that points to the root (#) keyword to the schema.

Declaration
public static JsonSchema RecursiveRefRoot(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Ref(JsonSchema, String)

Add a $ref keyword to the schema.

Declaration
public static JsonSchema Ref(this JsonSchema schema, string reference)
Parameters
Type Name Description
JsonSchema schema
System.String reference
Returns
Type Description
JsonSchema
| Improve this Doc View Source

RefRoot(JsonSchema)

Add a $ref keyword that points to the root (#) to the schema.

Declaration
public static JsonSchema RefRoot(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Required(JsonSchema, String[])

Add a required keyword to the schema.

Declaration
public static JsonSchema Required(this JsonSchema schema, params string[] values)
Parameters
Type Name Description
JsonSchema schema
System.String[] values
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Schema(JsonSchema, String)

Add a $schema keyword to the schema.

Declaration
public static JsonSchema Schema(this JsonSchema schema, string schemaCallout)
Parameters
Type Name Description
JsonSchema schema
System.String schemaCallout
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Then(JsonSchema, JsonSchema)

Add a then keyword to the schema.

Declaration
public static JsonSchema Then(this JsonSchema schema, JsonSchema thenSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema thenSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Title(JsonSchema, String)

Add a title keyword to the schema.

Declaration
public static JsonSchema Title(this JsonSchema schema, string title)
Parameters
Type Name Description
JsonSchema schema
System.String title
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Type(JsonSchema, JsonSchemaType)

Add a type keyword to the schema.

Declaration
public static JsonSchema Type(this JsonSchema schema, JsonSchemaType type)
Parameters
Type Name Description
JsonSchema schema
JsonSchemaType type
Returns
Type Description
JsonSchema
| Improve this Doc View Source

UnevaluatedItems(JsonSchema, JsonSchema)

Add an unevaluatedItems keyword to the schema.

Declaration
public static JsonSchema UnevaluatedItems(this JsonSchema schema, JsonSchema otherSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema otherSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

UnevaluatedProperties(JsonSchema, JsonSchema)

Add an unevaluatedProperties keyword to the schema.

Declaration
public static JsonSchema UnevaluatedProperties(this JsonSchema schema, JsonSchema otherSchema)
Parameters
Type Name Description
JsonSchema schema
JsonSchema otherSchema
Returns
Type Description
JsonSchema
| Improve this Doc View Source

UniqueItems(JsonSchema, Boolean)

Add a uniqueItems keyword to the schema.

Declaration
public static JsonSchema UniqueItems(this JsonSchema schema, bool unique)
Parameters
Type Name Description
JsonSchema schema
System.Boolean unique
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Vocabulary(JsonSchema, SchemaVocabulary, Boolean)

Add a single property requirement to the properties keyword.

Declaration
public static JsonSchema Vocabulary(this JsonSchema schema, SchemaVocabulary vocabulary, bool required)
Parameters
Type Name Description
JsonSchema schema
SchemaVocabulary vocabulary
System.Boolean required
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Vocabulary(JsonSchema, String, Boolean)

Add a single property requirement to the properties keyword.

Declaration
public static JsonSchema Vocabulary(this JsonSchema schema, string id, bool required)
Parameters
Type Name Description
JsonSchema schema
System.String id
System.Boolean required
Returns
Type Description
JsonSchema
| Improve this Doc View Source

WriteOnly(JsonSchema, Boolean)

Add a writeOnly keyword to the schema.

Declaration
public static JsonSchema WriteOnly(this JsonSchema schema, bool isWriteOnly)
Parameters
Type Name Description
JsonSchema schema
System.Boolean isWriteOnly
Returns
Type Description
JsonSchema