Aurora Agile Meta-Framework

Yaml for Aurora Agile Meta-Framework

*.aurora.yaml*.aurora.yml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your *.aurora.yaml and it validates in your browser — nothing is uploaded.

Validate a *.aurora.yaml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`version`	`string`	Schema version default: `"0.0.1"`
`boundedContextName`required	`string`	The name of the package, singular in kebab case
`moduleName`required	`string`	The name of the module, singular in kebab case
`moduleNames`required	`string`	The name of the module, plural in kebab case
`aggregateName`required	`string`	The name of the aggregateName, singular in pascal case, is composed of the boundedContextName plus the moduleName
`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`
`description`	`string`	Description of the module and its function and interaction with the other modules in the package
`front`	`object`	Appearance properties for front application
`front.gender`	`string`	Grammatical gender to be used in the front application default: `"masculine"` one of: `"masculine", "feminine"`
`front.iconModule`	`string`	Icon library to be used in the front application default: `"@ng-icons/lucide"` one of: `"@ng-icons/bootstr…, "@ng-icons/heroico…, "@ng-icons/ionicon…, "@ng-icons/materia…, "@ng-icons/materia…, "@ng-icons/css.gg" … (+30)`
`front.outlineIcon`	`string`	Outline icon to be used in the front application
`front.solidIcon`	`string`	Solid icon to be used in the front application
`front.detailMode`	`string`	Detail view mode for the front application, define detail in a dialog or in a separated view one of: `"view", "dialog"`
`front.embedSupport`	`boolean`	When true, the module generates embed-mode artifacts (form-embed component, embed columns config, list mode embed). Required when another module references this one via widget.type: grid-elements-manager. Default: false.
`front.displayField`	`string`	Human-readable display label for this aggregate. Accepts either an identifier (a single property name, e.g. 'name', 'email') or an interpolation template with {fieldName} placeholders (e.g. '{code} - {name}', 'Plan: {planId}'). Codegen
`aggregateProperties`	`array`	—
`additionalApis`	`array`	—
`excludedFiles`	`array<string>`	Files to be excluded from the module
`excludedOperations`	`array`	Operations to be excluded from the module

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
83 properties, 86% carrying a description, max nesting depth 8.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$comment`	JSON Schema Core, draft 2020-12	§8.3 — Comments With "$comment"
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`examples`	JSON Schema Validation, draft 2020-12	§9.5 — "examples"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`maxLength`	JSON Schema Validation, draft 2020-12	§6.3.1 — "maxLength"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas