Open Source Web Application Framework for ASP.NET Core
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

55 lines
2.6 KiB

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "app-descriptor.schema.json",
"title": "AppDescriptor",
"description": "Describes a low-code app. Apps partition the model into independently named scopes: other descriptors reference their owning app through the `app` field, and the default app is implicit.",
"markdownDescription": "AI guidance: create an app only when a group of entities, pages, forms, and scripts should be isolated under its own name. `name` is a lowercase kebab-case identifier such as `crm` or `field-service` and becomes part of runtime entity names (`<app>:<EntityName>`), app-scoped endpoint routes, and split descriptor file paths (`entities/<app>/...`). The name `default` denotes the implicit default app that always exists; descriptors without an `app` field belong to it. A `default` app descriptor is optional and only customizes the default app's `displayName`, `description`, and `metadata`; it cannot be archived. Set `isArchived` on other apps to hide them without deleting their descriptors.",
"type": "object",
"properties": {
"$schema": {
"type": "string",
"description": "Optional schema reference used when this descriptor is stored as a model descriptor file."
},
"name": {
"type": "string",
"description": "Stable lowercase kebab-case app name, for example 'crm' or 'field-service'. Maximum 64 characters. 'default' addresses the implicit default app, whose descriptor is optional and cannot be archived.",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"displayName": {
"type": "string",
"description": "User-facing app title shown by the designer and admin console. Maximum 128 characters.",
"minLength": 1,
"maxLength": 128
},
"description": {
"type": ["string", "null"],
"description": "Optional description for designer documentation."
},
"isArchived": {
"type": "boolean",
"description": "When true, the app is archived and hidden from active app lists. Descriptors that belong to the app are kept.",
"default": false
},
"metadata": {
"$ref": "descriptor-metadata.schema.json"
}
},
"required": ["name", "displayName"],
"if": {
"properties": { "name": { "const": "default" } },
"required": ["name"]
},
"then": {
"properties": { "isArchived": { "const": false } }
},
"additionalProperties": false,
"examples": [
{
"name": "crm",
"displayName": "CRM",
"description": "Customer relationship management app."
}
]
}