Skip to content

Latest commit

 

History

History
680 lines (623 loc) · 30.3 KB

SCHEMA.md

File metadata and controls

680 lines (623 loc) · 30.3 KB

ModelFileSchema

property type documentation
$defs DefsSchema Extra definitions, might be included via use or extend
record ModelDataTypeModelValidator Main record
settings SettingsSchema General settings, applies to all generated sources
version String Model version, default value 1.0.0

ModelDataTypeModelValidator

property type documentation
api-blueprint BlueprintSchema API blueprint details
config ConfigSchema Application config details
enum Array of Raw A list of possible values
ext ExtSchema Application extension details
extend String
json-schema-settings JSONSchema JSON Schema section of the model. Properties will be generated automatically
json-serializer JSONSerializerSchema
mapping-settings ModelMappingSchema Mapping definition
marshmallow ModelMarshmallowSchema
model-name String Name of the model, will be used as module name if no module is specified
module ModuleSchema Model module details
permissions ModelPermissionsSchema Permissions settings
pid PIDSchema PID settings
properties ObjectPropertiesField
proxy ProxySchema Settings for service proxy
record RecordClassSchema api/Record settings
record-dumper RecordDumperClassSchema Settings for record dumper
record-metadata RecordMetadataClassSchema Record metadata settings
required Boolean
resource ResourceClassSchema Resource class settings
resource-config ResourceConfigClassSchema Resource config class settings
sample SampleSchema Settings for sample document generator
saved-model SavedModelSchema
searchable Boolean Will the mapping/indexing be generated on model? (can be overriden on individual properties)
service ServiceClassSchema Service settings
service-config ServiceConfigClassSchema Service config settings
type String
ui ModelUISchema UI settings
use String

JSONSchema

property type documentation
alias String Alias under which jsonschema is referenced in setup.cfg
file String Path to schema file
generate Boolean Generate json schema (default is true)
module String Schema module
name String Schema name
template PermissiveSchema Template that will be merged with the schema
version String Schema version

PermissiveSchema

property type documentation
extend String
use String

ModelMappingSchema

property type documentation
alias String Index alias, under which the mapping is registered in setup.cfg
file String Path to index file
generate Boolean Generate mapping (default is true)
index String Index name
module String Module with mapping definition
template PermissiveSchema Mapping template, merged with generated mapping

FieldSchema

property type documentation
array ArrayDataTypeModelValidator
boolean BooleanDataTypeModelValidator
date DateDataTypeModelValidator
datetime DateTimeDataTypeModelValidator
double DoubleDataTypeModelValidator
edtf-interval EDTFIntervalTypeModelValidator
edtf EDTFDataTypeModelValidator
flattened FlattenDataTypeModelValidator
float FloatDataTypeModelValidator
fulltext+keyword FulltextKeywordDataTypeModelValidator
fulltext FulltextDataTypeModelValidator
integer IntegerDataTypeModelValidator
keyword KeywordDataTypeModelValidator
model ModelDataTypeModelValidator
nested NestedDataTypeModelValidator
object ObjectDataTypeModelValidator
time TimeDataTypeModelValidator
url URLDataTypeModelValidator

IntegerDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
exclusiveMaximum Integer
exclusiveMinimum Integer
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maximum Integer
minimum Integer
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

PropertyUISchema

property type documentation
extend String
marshmallow PropertyMarshmallowSchema UI marshmallow
use String

PropertyMarshmallowSchema

property type documentation
arguments Array of String
extend String
field String
field-class String
field-name String
imports Array of ImportSchema
read Boolean
use String
validators Array of String
write Boolean

ImportSchema

property type documentation
alias String
extend String
import String
use String

SampleSchema

property type documentation
extend String
faker String The faker to use for generating the sample
params Raw Params for the faker
skip Boolean Set true to skip generating sample for the field
use String

FacetsSchema

property type documentation
searchable Boolean True if the field is rendered into a facet

FloatDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
exclusiveMaximum Float
exclusiveMinimum Float
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maximum Float
minimum Float
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

DoubleDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
exclusiveMaximum Float
exclusiveMinimum Float
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maximum Float
minimum Float
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

BooleanDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

DateDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

TimeDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

DateTimeDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

EDTFDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

EDTFIntervalTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

FulltextDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maxLength Integer
minLength Integer
regex String
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

KeywordDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maxLength Integer
minLength Integer
regex String
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

FulltextKeywordDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maxLength Integer
minLength Integer
regex String
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

ObjectDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow ObjectMarshmallowSchema
properties ObjectPropertiesField
required Boolean
sample SampleSchema
type String
ui ObjectUISchema

ObjectPropertiesField

property type documentation
* FieldSchema None

ObjectUISchema

property type documentation
extend String
marshmallow ObjectMarshmallowSchema
use String

ObjectMarshmallowSchema

property type documentation
arguments Array of String
base-classes Array of String List of marshmallow base classes
class String The name of the marshmallow class
extend String
extra-fields Array of ExtraField Extra fields to generate into the marhsmallow class
field String
field-class String
field-name String
generate Boolean Generate the marshmallow class (default is true)
imports Array of ImportSchema
module String Class module
read Boolean
use String
validators Array of String
write Boolean

ExtraField

property type documentation
name String Name (lhs) of the field
value String Literal definition (rhs) of the field

NestedDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow ObjectMarshmallowSchema
properties ObjectPropertiesField
required Boolean
sample SampleSchema
type String
ui ObjectUISchema

FlattenDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

ArrayDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
extend String
facets FacetsSchema
items FieldSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maxItems Integer
minItems Integer
required Boolean
sample ArraySampleSchema
type String
ui PropertyUISchema
uniqueItems Boolean
use String

ArraySampleSchema

property type documentation
count Integer
extend String
use String

URLDataTypeModelValidator

property type documentation
enum Array of Raw A list of possible values
facets FacetsSchema
jsonschema PermissiveSchema
mapping PermissiveSchema
marshmallow PropertyMarshmallowSchema
maxLength Integer
minLength Integer
regex String
required Boolean
sample SampleSchema
type String
ui PropertyUISchema

ModelDataTypeModelValidator

property type documentation
api-blueprint BlueprintSchema API blueprint details
config ConfigSchema Application config details
enum Array of Raw A list of possible values
ext ExtSchema Application extension details
extend String
json-schema-settings JSONSchema JSON Schema section of the model. Properties will be generated automatically
json-serializer JSONSerializerSchema
mapping-settings ModelMappingSchema Mapping definition
marshmallow ModelMarshmallowSchema
model-name String Name of the model, will be used as module name if no module is specified
module ModuleSchema Model module details
permissions ModelPermissionsSchema Permissions settings
pid PIDSchema PID settings
properties ObjectPropertiesField
proxy ProxySchema Settings for service proxy
record RecordClassSchema api/Record settings
record-dumper RecordDumperClassSchema Settings for record dumper
record-metadata RecordMetadataClassSchema Record metadata settings
required Boolean
resource ResourceClassSchema Resource class settings
resource-config ResourceConfigClassSchema Resource config class settings
sample SampleSchema Settings for sample document generator
saved-model SavedModelSchema
searchable Boolean Will the mapping/indexing be generated on model? (can be overriden on individual properties)
service ServiceClassSchema Service settings
service-config ServiceConfigClassSchema Service config settings
type String
ui ModelUISchema UI settings
use String

ModelPermissionsSchema

property type documentation
base-classes Array of String Base classes for the generated permission class
class String Qualified name of the generated class
extra-code String Extra code to be copied below the permission class
generate Boolean Set to true to generate the permissions class
imports Array of ImportSchema List of python imports
module String Module where the permissions will be placed
presets Array of String A list of presets that will be merged with the permissions class.

ModelMarshmallowSchema

property type documentation
base-classes Array of String List of marshmallow base classes
class String The name of the marshmallow class
extra-code String Extra code to be merged to marshmallow file
extra-fields Array of ExtraField Extra fields to generate into the marhsmallow class
generate Boolean Generate the marshmallow class (default is true)
imports Array of ImportSchema Python imports that will be put to marshmallow file
module String Class module

ModelUISchema

property type documentation
marshmallow ModelMarshmallowSchema

JSONSerializerSchema

property type documentation
base-classes Array of String List of base classes
class String UI serializer class qualified name
extra-code String Extra code to be put below the generated ui serializer class
imports Array of ImportSchema List of python imports
module String UI serializer class module

ServiceClassSchema

property type documentation
base-classes Array of String List of base classes
class String Qualified name of the service class
config_key String Key under which actual service class is registered in config
extra-code String Extra code to be put below the generated service class
generate Boolean Generate service class (default)
imports Array of ImportSchema List of python imports
module String Class module
proxy String name of the service proxy, will be put to proxies package

ServiceConfigClassSchema

property type documentation
base-classes Array of String List of base classes
class String Qualified name of the service config class
components Array of String List of service components
config_key String Key under which the actual service config is registered in config
extra-code String Extra code to be put below the service config class
generate Boolean Generate the service config
generate-links Boolean Generate links section (default)
imports Array of ImportSchema List of python imports
module String Class module
service-id String ID of the service

RecordMetadataClassSchema

property type documentation
alembic String module where alembic files are stored
alias String Alias under which the metadata is registered in setup.cfg
base-classes Array of String A list of base classes
class String Qualified name of the class
extra-code String Extra code to be put below the record
generate Boolean True to generate the metadata class
imports Array of ImportSchema List of python imports
module String Module where the metadata class resides
table String Name of the database table

RecordDumperClassSchema

property type documentation
base-classes Array of String List of base classes
class String Qualified name of the class
extensions Array of String List of dumper extensions
extra-code String Extra code to be copied to the bottom of the dumper file
generate Boolean Generate the dumper class
imports Array of ImportSchema List of python imports
module String Class module

PIDSchema

property type documentation
context-class String Context class, PIDFieldContext is used if not passed
field-args Array of String Field arguments, default is create=True
field-class String Field class, PIDField is used if not passed in
generate Boolean Set to True (default) provider class
imports Array of ImportSchema A list of python imports
module String Module where the pid provider will be placed
provider-base-classes Array of String List of provider base classes
provider-class String Fully qualified name of the provider class
type String PID type, generated from model name if not passed

ProxySchema

property type documentation
module String

SavedModelSchema

property type documentation
alias String Alias under which the model is registered in setup.cfg
file String File where to save the model
module String Module where the file is saved

ResourceClassSchema

property type documentation
base-classes Array of String A list of base classes
class String Qualified name of the resource class
config_key String Name of the config entry that holds the current resource class name
extra-code String Extra code to be put to the bottom of the generated file
generate Boolean Generate the resource class (default)
imports Array of ImportSchema List of python imports
module String Class module
proxy String name of the generated proxy, will be put to proxies module

ResourceConfigClassSchema

property type documentation
base-classes Array of String A list of base classes
base-url String The base url of the resource
class String Qualified name of the config class
config_key String Name of the config entry that holds the current resource class name
extra-code String Extra code to be put below the generated config class
generate Boolean Generate the resource config class (default)
imports Array of ImportSchema List of python imports
module String Class module

RecordClassSchema

property type documentation
base-classes Array of String Model base classes
class String Qualified name of the class
extra-code String Extra code to copy to record file
generate Boolean Set true to generate the class (default)
imports Array of ImportSchema List of python imports
module String Class module

BlueprintSchema

property type documentation
alias String Alias under which the blueprint will be registered in the setup.cfg
extra_code String Extra code to be pasted to blueprint
function String Fully qualified blueprint function
generate Boolean Generate blueprint, defaults to true
imports Array of ImportSchema Python imports
module String Module that will contain the blueprint

ConfigSchema

property type documentation
extra_code String Extra code that will be pasted to app config
imports Array of ImportSchema Python imports
module String Module with app config

ExtSchema

property type documentation
alias String Alias under which the extension will be registered in setup.cfg and in app.extensions
base-classes String A list of extension's base classes
class String Extension class name
extra_code String Extra code that will be pasted to app extension module
imports Array of ImportSchema Python imports
module String Module with ext schema

ModuleSchema

property type documentation
alias String Alias to use for setup.cfg etc.
base String Base name of the module (if the module has dot)
base-upper String Uppercase of the base name
kebab-module String Kebab case of the module
path String Path on the filesystem with the top-level module
prefix String Prefix that will be applied to class names
prefix_snake String Snake variant of the prefix
prefix_upper String Uppercase variant of the prefix
qualified String Module (fully qualified) where the model is generated
suffix String Suffix that will be applied to various names
suffix_snake String Snake variant of the suffix
suffix_upper String Uppercase variant of the suffix

SampleSchema

property type documentation
count Integer Number of generated records
file String File into which the records will be generated

DefsSchema

property type documentation

SettingsSchema

property type documentation
opensearch SettingsOpenSearchSchema
python SettingsPythonSchema
schema-server String

SettingsPythonSchema

property type documentation
use-autoflake Boolean
use-black Boolean
use-isort Boolean

SettingsOpenSearchSchema

property type documentation
version String