Add lowcode JSON schema definitions#24893
Merged
berkansasmaz merged 4 commits intodevfrom Feb 18, 2026
Merged
Conversation
Introduce a set of JSON Schema definitions for the ABP Low Code model. Adds schema files for entities, properties, property types, UI descriptors, form availability, enums, foreign keys, interceptors, command interceptors, validators, and custom HTTP endpoints, plus a top-level model.schema.json that references these definitions to validate model.json configuration files. These schemas enable validation and tooling for lowcode entity/config definitions and custom endpoint JavaScript payloads.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds JSON Schema (draft 2020-12) files under lowcode/schema/ to validate ABP Low Code model.json configurations, including descriptors for entities, properties, enums, endpoints, interceptors, and validators.
Changes:
- Introduces a root
model.schema.jsondescribingmodel.jsonstructure. - Adds descriptor schemas for entities/properties/UI/enums/foreign keys/validators.
- Adds schemas for custom endpoints and command interceptors (including interceptor timing/type).
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| lowcode/schema/model.schema.json | Root schema for lowcode model.json referencing definition schemas. |
| lowcode/schema/definitions/validator-descriptor.schema.json | Validator descriptor schema for property validators. |
| lowcode/schema/definitions/interceptor-type.schema.json | Enum schema for interceptor execution timing. |
| lowcode/schema/definitions/foreign-key-descriptor.schema.json | Schema for foreign key relationship configuration. |
| lowcode/schema/definitions/enum-descriptor.schema.json | Schema for enum definitions used by entity properties. |
| lowcode/schema/definitions/entity-ui-descriptor.schema.json | Schema for entity-level UI configuration. |
| lowcode/schema/definitions/entity-property-ui-form-availability.schema.json | Enum schema for property form visibility/availability. |
| lowcode/schema/definitions/entity-property-ui-descriptor.schema.json | Schema for property-level UI configuration. |
| lowcode/schema/definitions/entity-property-type.schema.json | Enum schema for supported property data types. |
| lowcode/schema/definitions/entity-property-descriptor.schema.json | Schema describing an entity property (type, FK, UI, validators). |
| lowcode/schema/definitions/entity-descriptor.schema.json | Schema describing an entity (properties, UI, interceptors). |
| lowcode/schema/definitions/endpoint-descriptor.schema.json | Schema for custom HTTP endpoints that execute JavaScript. |
| lowcode/schema/definitions/command-interceptor-descriptor.schema.json | Schema for command interceptors (Create/Update/Delete + JS). |
Comment on lines
+7
to
+24
| "name": { | ||
| "type": "string", | ||
| "description": "Unique identifier for the endpoint" | ||
| }, | ||
| "route": { | ||
| "type": "string", | ||
| "description": "URL route pattern (e.g., '/api/custom/products/{id}')" | ||
| }, | ||
| "method": { | ||
| "type": "string", | ||
| "description": "HTTP method", | ||
| "enum": ["GET", "POST", "PUT", "DELETE", "PATCH"], | ||
| "default": "GET" | ||
| }, | ||
| "javascript": { | ||
| "type": "string", | ||
| "description": "JavaScript code to execute. Has access to context object with request, db, currentUser, emailSender." | ||
| }, |
There was a problem hiding this comment.
Required string fields (name, route, javascript) are not constrained to non-empty values. Elsewhere in these schemas, required names use minLength: 1; adding similar constraints here would prevent accepting empty strings that would break endpoint registration at runtime.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
berkansasmaz
approved these changes
Feb 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.