Show / Hide Table of Contents

Class GetterExtensions

Extends JsonSchema to aid in fetching properties.

Inheritance
System.Object
GetterExtensions
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 GetterExtensions

Methods

| Improve this Doc View Source

AdditionalItems(JsonSchema)

Gets the value for the additionalItems keyword, if present.

Declaration
public static JsonSchema? AdditionalItems(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

AdditionalProperties(JsonSchema)

Gets the value for the additionalProperties keyword, if present.

Declaration
public static JsonSchema? AdditionalProperties(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

AllOf(JsonSchema)

Gets the value for the allOf keyword, if present.

Declaration
public static List<JsonSchema>? AllOf(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.List<JsonSchema>>
| Improve this Doc View Source

AnyOf(JsonSchema)

Gets the value for the anyOf keyword, if present.

Declaration
public static List<JsonSchema>? AnyOf(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.List<JsonSchema>>
| Improve this Doc View Source

Comment(JsonSchema)

Gets the value for the $comment keyword, if present.

Declaration
public static string? Comment(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Const(JsonSchema)

Gets the value for the const keyword, if present.

Declaration
public static JsonValue? Const(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonValue>
| Improve this Doc View Source

Contains(JsonSchema)

Gets the value for the contains keyword, if present.

Declaration
public static JsonSchema? Contains(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

ContentEncoding(JsonSchema)

Gets the value for the contentEncoding keyword, if present.

Declaration
public static string? ContentEncoding(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

ContentMediaType(JsonSchema)

Gets the value for the contentMediaType keyword, if present.

Declaration
public static string? ContentMediaType(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

ContentSchema(JsonSchema)

Gets the value for the contentSchema keyword, if present.

Declaration
public static JsonSchema? ContentSchema(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

Default(JsonSchema)

Gets the value for the default keyword, if present.

Declaration
public static JsonValue? Default(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonValue>
| Improve this Doc View Source

Definitions(JsonSchema)

Gets the value for the definitions keyword, if present.

Declaration
public static Dictionary<string, JsonSchema>? Definitions(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.Dictionary<System.String, JsonSchema>>
| Improve this Doc View Source

Defs(JsonSchema)

Gets the value for the $defs keyword, if present.

Declaration
public static Dictionary<string, JsonSchema>? Defs(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.Dictionary<System.String, JsonSchema>>
| Improve this Doc View Source

Description(JsonSchema)

Gets the value for the description keyword, if present.

Declaration
public static string? Description(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Else(JsonSchema)

Gets the value for the else keyword, if present.

Declaration
public static JsonSchema? Else(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

Enum(JsonSchema)

Gets the value for the enum keyword, if present.

Declaration
public static List<JsonValue>? Enum(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.List<JsonValue>>
| Improve this Doc View Source

Examples(JsonSchema)

Gets the value for the examples keyword, if present.

Declaration
public static List<JsonValue>? Examples(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.List<JsonValue>>
| Improve this Doc View Source

ExclusiveMaximum(JsonSchema)

Gets the value for the exclusiveMaximum keyword, if present.

Declaration
public static double? ExclusiveMaximum(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

ExclusiveMaximumDraft04(JsonSchema)

Gets the value for the exclusiveMaximum keyword for draft-04, if present.

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

ExclusiveMinimum(JsonSchema)

Gets the value for the exclusiveMinimum keyword, if present.

Declaration
public static double? ExclusiveMinimum(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

ExclusiveMinimumDraft04(JsonSchema)

Gets the value for the exclusiveMinimum keyword for draft-04, if present.

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

Format(JsonSchema)

Gets the value for the format keyword, if present.

Declaration
public static string? Format(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Get<T>(JsonSchema)

Gets the indicated keyword, if present.

Declaration
public static T Get<T>(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

Id(JsonSchema)

Gets the value for the $id (or id for draft-04) keyword, if present.

Declaration
public static string? Id(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Items(JsonSchema)

Gets the value for the items keyword, if present.

Declaration
public static List<JsonSchema>? Items(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.List<JsonSchema>>
| Improve this Doc View Source

MaxContains(JsonSchema)

Gets the value for the maxContains keyword, if present.

Declaration
public static double? MaxContains(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

Maximum(JsonSchema)

Gets the value for the maximum keyword, if present.

Declaration
public static double? Maximum(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MaxItems(JsonSchema)

Gets the value for the maxItems keyword, if present.

Declaration
public static double? MaxItems(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MaxLength(JsonSchema)

Gets the value for the maxLength keyword, if present.

Declaration
public static double? MaxLength(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MaxProperties(JsonSchema)

Gets the value for the maxProperties keyword, if present.

Declaration
public static double? MaxProperties(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MinContains(JsonSchema)

Gets the value for the minContains keyword, if present.

Declaration
public static double? MinContains(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

Minimum(JsonSchema)

Gets the value for the minimum keyword, if present.

Declaration
public static double? Minimum(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MinItems(JsonSchema)

Gets the value for the minItems keyword, if present.

Declaration
public static double? MinItems(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MinLength(JsonSchema)

Gets the value for the minLength keyword, if present.

Declaration
public static double? MinLength(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MinProperties(JsonSchema)

Gets the value for the minProperties keyword, if present.

Declaration
public static double? MinProperties(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

MultipleOf(JsonSchema)

Gets the value for the multipleOf keyword, if present.

Declaration
public static double? MultipleOf(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

Not(JsonSchema)

Gets the value for the not keyword, if present.

Declaration
public static JsonSchema? Not(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

OneOf(JsonSchema)

Gets the value for the oneOf keyword, if present.

Declaration
public static List<JsonSchema>? OneOf(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.List<JsonSchema>>
| Improve this Doc View Source

Pattern(JsonSchema)

Gets the value for the pattern keyword, if present.

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

PatternProperties(JsonSchema)

Gets the value for the patternProperties keyword, if present.

Declaration
public static Dictionary<string, JsonSchema>? PatternProperties(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.Dictionary<System.String, JsonSchema>>
| Improve this Doc View Source

Properties(JsonSchema)

Gets the value for the properties keyword, if present.

Declaration
public static Dictionary<string, JsonSchema>? Properties(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.Dictionary<System.String, JsonSchema>>
| Improve this Doc View Source

PropertyNames(JsonSchema)

Gets the value for the propertyNames keyword, if present.

Declaration
public static JsonSchema? PropertyNames(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

ReadOnly(JsonSchema)

Gets the value for the readOnly keyword, if present.

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

RecursiveAnchor(JsonSchema)

Gets the value for the $recursiveAnchor keyword, if present.

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

RecursiveRef(JsonSchema)

Gets the value for the recursiveRef keyword, if present.

Declaration
public static string? RecursiveRef(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Ref(JsonSchema)

Gets the value for the $ref keyword, if present.

Declaration
public static string? Ref(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

RefResolved(JsonSchema)

Gets the resolved schema for the $ref keyword, if present.

Declaration
public static JsonSchema? RefResolved(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

Required(JsonSchema)

Gets the value for the required keyword, if present.

Declaration
public static List<string>? Required(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.List<System.String>>
| Improve this Doc View Source

Schema(JsonSchema)

Gets the value for the $schema keyword, if present.

Declaration
public static string? Schema(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Then(JsonSchema)

Gets the value for the then keyword, if present.

Declaration
public static JsonSchema? Then(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

Title(JsonSchema)

Gets the value for the title keyword, if present.

Declaration
public static string? Title(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

UnevaluatedItems(JsonSchema)

Gets the value for the unevaluatedItems keyword, if present.

Declaration
public static JsonSchema? UnevaluatedItems(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

UnevaluatedProperties(JsonSchema)

Gets the value for the unevaluatedProperties keyword, if present.

Declaration
public static JsonSchema? UnevaluatedProperties(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<JsonSchema>
| Improve this Doc View Source

UniqueItems(JsonSchema)

Gets the value for the uniqueItems keyword, if present.

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

Vocabulary(JsonSchema)

Gets the value for the uniqueItems keyword, if present.

Declaration
public static Dictionary<SchemaVocabulary, bool>? Vocabulary(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Nullable<System.Collections.Generic.Dictionary<SchemaVocabulary, System.Boolean>>
| Improve this Doc View Source

WriteOnly(JsonSchema)

Gets the value for the writeOnly keyword, if present.

Declaration
public static bool WriteOnly(this JsonSchema schema)
Parameters
Type Name Description
JsonSchema schema
Returns
Type Description
System.Boolean
  • Improve this Doc
  • View Source
Back to top Generated by DocFX