jschon.vocabulary.annotation

class jschon.vocabulary.annotation.ContentEncodingKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

instance_types: Tuple[str, ...] = ('string',)

The types of instance that the keyword can evaluate.

json: JSON
key: str = 'contentEncoding'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.ContentMediaTypeKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

instance_types: Tuple[str, ...] = ('string',)

The types of instance that the keyword can evaluate.

json: JSON
key: str = 'contentMediaType'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.ContentSchemaKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

evaluate(instance, result)
Parameters:
Return type:

None

depends_on: Tuple[str, ...] = ('contentMediaType',)

Keywords that must be evaluated before this keyword can be evaluated.

instance_types: Tuple[str, ...] = ('string',)

The types of instance that the keyword can evaluate.

json: JSON
key: str = 'contentSchema'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.DefaultKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

json: JSON
key: str = 'default'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.DeprecatedKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

json: JSON
key: str = 'deprecated'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.DescriptionKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

json: JSON
key: str = 'description'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.ExamplesKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

json: JSON
key: str = 'examples'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.ReadOnlyKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

json: JSON
key: str = 'readOnly'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.TitleKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

json: JSON
key: str = 'title'

The keyword name as it appears in a schema object.

parentschema: JSONSchema
class jschon.vocabulary.annotation.WriteOnlyKeyword(parentschema, value)
Parameters:

  • parentschema (JSONSchema) –

  • value (JSONCompatible) –

json: JSON
key: str = 'writeOnly'

The keyword name as it appears in a schema object.

parentschema: JSONSchema