|
| 1 | +--- |
| 2 | +title: "Coming Soon" |
| 3 | +description: "Upcoming features for the RIDDL ecosystem" |
| 4 | +--- |
| 5 | + |
| 6 | +# Coming Soon |
| 7 | + |
| 8 | +This page outlines upcoming capabilities for the RIDDL ecosystem. These |
| 9 | +features are under active development and will be available through |
| 10 | +[Synapify](../synapify/index.md) and related tooling. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Simulation |
| 15 | + |
| 16 | +The [riddlsim](https://github.com/ossuminc/riddlsim) engine executes RIDDL |
| 17 | +models against test scenarios, validating behavior before implementation. |
| 18 | + |
| 19 | +**Why simulate?** |
| 20 | + |
| 21 | +- **Catch design errors early** before they become expensive implementation |
| 22 | + bugs |
| 23 | +- **Verify state transitions** to ensure entities move through expected |
| 24 | + lifecycles |
| 25 | +- **Test edge cases** that might be overlooked in manual review |
| 26 | +- **Build stakeholder confidence** by demonstrating working behavior early |
| 27 | +- **Document expected behavior** through executable scenarios |
| 28 | + |
| 29 | +Simulation scenarios define inputs, expected events, and state assertions. |
| 30 | +When a scenario runs, the simulator parses your model, executes the |
| 31 | +scenario steps, and reports whether outcomes match expectations. |
| 32 | + |
| 33 | +For detailed information on simulation capabilities and integration with |
| 34 | +Synapify, see the [Synapify Simulation Guide](../synapify/simulation.md). |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## Generation |
| 39 | + |
| 40 | +The RIDDL ecosystem will support code and artifact generation from validated |
| 41 | +models. Generation transforms your domain model into runnable infrastructure, |
| 42 | +documentation, and integration artifacts. |
| 43 | + |
| 44 | +### Documentation Generators |
| 45 | + |
| 46 | +| Target | Description | |
| 47 | +|--------|-------------| |
| 48 | +| **Hugo** | Static documentation site with navigation, diagrams, and cross-references. Currently available. | |
| 49 | +| **AsciiDoc** | Technical documentation in AsciiDoc format for integration with enterprise documentation systems. | |
| 50 | +| **Diagrams** | Mermaid-based visualizations including context maps, data flow, sequence diagrams, and entity relationships. | |
| 51 | + |
| 52 | +### API & Schema Generators |
| 53 | + |
| 54 | +| Target | Description | |
| 55 | +|-------------|-------------------------------------------------------------------------------------------------------------| |
| 56 | +| **OpenAPI** | OpenAPI (Swagger) specifications documenting REST APIs implied by Applications and their endpoints. | |
| 57 | +| **gRPC** | Google's efficient serialization format protobuf enables gRPC services and cross-language interoperability. | |
| 58 | +| **Smithy** | AWS Interface Definition Language for defining services that integrate with AWS infrastructure. | |
| 59 | + |
| 60 | +### Runtime Code Generators |
| 61 | + |
| 62 | +| Target | Description | |
| 63 | +|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 64 | +| **Akka** | Complete Scala/Akka project including actors, protobuffers, sbt build files, and runtime dependencies. Generates infrastructure code while leaving business logic to developers or have AI do the whole job. | |
| 65 | +| **Quarkus** | Complete Java/Quarkus project using many Quarkus ecosystem features for reactive distributed systems. | |
| 66 | + |
| 67 | +### Integration Generators |
| 68 | + |
| 69 | +| Target | Description | |
| 70 | +|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 71 | +| **Backstage** | Catalog entries for [Spotify Backstage](https://backstage.io/) developer portals, documenting service ownership and relationships. | |
| 72 | +| **BAST** | Binary Abstract Syntax Tree format for faster parsing. Saves validated models in a binary format that loads quickly, avoiding re-parsing and re-validation. | |
| 73 | + |
| 74 | +### Extending Generation |
| 75 | + |
| 76 | +The generation architecture is designed for extensibility. Custom generators can |
| 77 | +be implemented to target additional platforms, frameworks, or output formats. |
| 78 | +If you need a specific kind of generation, email us at mailto:support@ossuminc.com |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +!!! NOTE: Timeline |
| 83 | + |
| 84 | +These features are being developed iteratively. Generators will be released |
| 85 | +as they reach production quality. For the latest status, see the |
| 86 | +[Synapify documentation](../synapify/index.md). |
0 commit comments