json.schema.Schema¶
An json.schema.Schema class represents a JSON Schema.
-
class
json.schema.Schema¶ Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a
NotImplementedErrorexception.
Class methods¶
-
classmethod
json.schema.Schema.create_from_buffer(type cls, buf, *, catalog=None, **kargs)¶ Returns a tuple with a
json.schema.Schemaandxml.ErrorLogobject. Constructs a newjson.schema.Schemaobject after parsing the JSON content in the given buffer according to the JSON schema draft 4 specification. Optional user XML catalogs can be specified with the catalog argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_json_valjsonschema.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLogobject.
-
classmethod
json.schema.Schema.create_from_url(type cls, url, *, catalog=None, **kargs)¶ Returns a tuple with a
json.schema.Schemaandxml.ErrorLogobject. Constructs a newjson.schema.Schemaobject after parsing the JSON content from the given url according to the JSON schema draft 4 specification. Optional user XML catalogs can be specified with the catalog argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_json_valjsonschema.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLogobject.
-
classmethod
json.schema.Schema.validate_buffer(type cls, buf, *, catalog=None, **kargs)¶ Validates the JSON Schema document from the given buffer buf according to the JSON schema draft 4 specification and returns
xml.ErrorLogobject with the results. Optional user XML catalogs can be specified with the catalog argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_json_valjsonschema.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLogobject.
-
classmethod
json.schema.Schema.validate_url(type cls, url, *, catalog=None, **kargs)¶ Validates the JSON Schema document at the given url according to the JSON schema draft 4 specification and returns
xml.ErrorLogobject with the results. Optional user XML catalogs can be specified with the catalog argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_json_valjsonschema.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLogobject.