Aurora Agile Meta-Framework 1.0 (SchemaStore) JSON Schema

Schema URL

https://catalog.lintel.tools/schemas/schemastore/aurora-agile-meta-framework/versions/1.0.json

← Back to Aurora Agile Meta-Framework

Type: object

Make agile applications without technical debt

Properties

boundedContextName string required

The name of the bounded context, singular in kebab-case

minLength=2

moduleName string required

The name of the module, singular in kebab-case

minLength=2

moduleNames string required

The name of the module, plural in kebab-case

minLength=2

aggregateName string required

The name of the aggregateName, singular in PascalCase

minLength=2

version string

Schema version

Default: "0.0.1"

minLength=2

hasOAuth boolean

Enabled authentication for this module

Default: false

hasTenant boolean

Enabled tenant for this module

Default: false

hasAuditing boolean

Enabled auditing for this module

Default: false

aggregateProperties property[]

aggregateI18nProperties property[]

additionalApis apiDefinition[]

Definitions

property object

name string required

The name of property, in camelCase

minLength=2

type string required

The type of property

Values: "bigint.unsigned" "bigint" "blob.long" "blob.medium" "blob.tiny" "blob" "boolean" "char" "date" "decimal" "enum" "float" "id" "int.unsigned" "int" "json" "manyToMany" "password" "relationship" "smallint.unsigned" "smallint" "text" "timestamp" "tinyint.unsigned" "tinyint" "varchar"

length number

Set max length to property

min=1

maxLength number

Set max length to property

min=1

nullable boolean

Set property to nullable

primaryKey boolean

Set property to primary key

index string

To define property like a index

Values: "index" "unique"

indexName string

The name of index, if there are various indexes with the same name, they will be grouped

minLength=2

enumOptions string[]

Values for enum type

defaultValue number | string | boolean

Default value for property

example number | string | boolean

Example value for property, this value will be used in swagger documentation

decimals number[]

Total digits of the number and length of the decimal places in the back of the number, example: [10, 2].

autoIncrement boolean

Set number property as auto increment

relationship object

Relationship definition for this property

10 nested properties

type string

The type of web component

Values: "many-to-many" "many-to-one" "none" "one-to-many" "one-to-one"

singularName string

Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book

minLength=2

aggregate string

Aggregate referring to this relationship, example: LibraryAuthor

minLength=2

modulePath string

Path to the module that refers to this relationship, example: library/author

minLength=2

key string

Property key that refers to this relationship, only for many-to-one relationship, example: id

minLength=2

field string

Field to obtain the relationship data, example: author

minLength=2

avoidConstraint boolean

Avoid constraint rules for this relationship

packageName string

Path to packageName where is the relationship, example: @aurora-ts/core

minLength=2

isDenormalized boolean

Set many-to-many relationship as denormalized, creating a field to store the selected ids

pivot object

Relationship pivot table definition for this relationship

3 nested properties

aggregate string

AggregateName of Pivot table, example: IamRolesAccounts

minLength=2

modulePath string

Module path where table model file will be saved, example: iam/role

minLength=2

fileName string

Filename of pivot table model file, example: roles-accounts

minLength=2

webComponent object

Web Component that will be rendered for this property

1 nested properties

type string

The type of web component

Values: "grid-select-element" "grid-elements-manager" "select"

apiDefinition object

path string required

Path to access api

minLength=2

resolverType string required

Type of resolver, query or mutation

Values: "query" "mutation"

httpMethod string required

Verb of api rest

Values: "get" "post" "put" "delete" "patch"

relationship object

Relationship definition for this property

type string

The type of web component

Values: "many-to-many" "many-to-one" "none" "one-to-many" "one-to-one"

singularName string

Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book

minLength=2

aggregate string

Aggregate referring to this relationship, example: LibraryAuthor

minLength=2

modulePath string

Path to the module that refers to this relationship, example: library/author

minLength=2

key string

Property key that refers to this relationship, only for many-to-one relationship, example: id

minLength=2

field string

Field to obtain the relationship data, example: author

minLength=2

avoidConstraint boolean

Avoid constraint rules for this relationship

packageName string

Path to packageName where is the relationship, example: @aurora-ts/core

minLength=2

isDenormalized boolean

Set many-to-many relationship as denormalized, creating a field to store the selected ids

pivot object

Relationship pivot table definition for this relationship

3 nested properties

aggregate string

AggregateName of Pivot table, example: IamRolesAccounts

minLength=2

modulePath string

Module path where table model file will be saved, example: iam/role

minLength=2

fileName string

Filename of pivot table model file, example: roles-accounts

minLength=2

webComponent object

Web Component that will be rendered for this property

type string

The type of web component

Values: "grid-select-element" "grid-elements-manager" "select"

pivotTable object

Relationship pivot table definition for this relationship

aggregate string

AggregateName of Pivot table, example: IamRolesAccounts

minLength=2

modulePath string

Module path where table model file will be saved, example: iam/role

minLength=2

fileName string

Filename of pivot table model file, example: roles-accounts

minLength=2