Skip to content

docs: updating README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javiercavlop merged 1 commit into from
Jan 29, 2026
Merged

docs: updating README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ graph TD
Router -->|engine_id=random-search| RS[Random Search Engine]

MZ -->|Solve via Gecode| Solution
RS -->|Solve via Evolution| Solution
RS -->|Solve via Random Heuristic| Solution

Solution --> Gateway
Gateway -->|HTTP 200| User
Expand Down Expand Up @@ -50,6 +50,26 @@ graph TD
- **Schema Explorer**: Interactive JSON schema viewer with search and navigation
- **Light/Dark Theme**: System-aware theme with persistence

## 📐 Schemas & Specification

OpenBinding validates incoming requests against two schema layers:

1. **General schema** (engine-agnostic):
- JSON Schema (structural validation): `schemas/general/schema.json`
- Specification / semantics (human-readable): `schemas/general/schema.specification.md`

The specification document explains the intent and semantics behind the JSON Schema, including:
- The instance model (tasks, candidates, providers, features)
- Workflow modeling (`composition` as structured tree or DAG)
- QoS aggregation and normalization (`aggregation_policies`)
- Constraints and objectives, plus invariants that require a second validation pass

2. **Specialization schemas** (engine-specific constraints):
- `schemas/specializations/minizinc-csp.schema.json`
- `schemas/specializations/random-search.schema.json`

Example payloads that follow these schemas live in `examples/`.

## 🚀 Getting Started

### Prerequisites
Expand Down