AdvancedServiceContractConcepts2.mdsl

API description AdvancedServiceConceptsPreview 
version "5.3"
overview "This service contract features error reporting, state transitions, compensation, and event emission/reception"

data type SampleDTOOpaque "location":P // not specified here but in an external JSON Schema
data type SampleDTO {ID, D} // these two incomplete specifications can be quick fixed in the plugin
data type Placeholder P // this incomplete specifications can be quick fixed in the plugin
data type Placeholder2 "nameOnly" // this incomplete specifications can be quick fixed in the plugin
data type Placeholder3 "name":P // this incomplete specifications can be quick fixed in the plugin

event type SomethingHasHappened {"when":D<string>, "what":D<string>}
event type ServerSideProcessingComplete
event type FailureMessage

command type doSomethingOnServerSide, undoSomethingOnServerSide

endpoint type HelloWorldEndpoint
 exposes 
  operation doSomethingOnServerSide with responsibility STATE_TRANSITION_OPERATION
    expecting payload D<string>  
    delivering payload SampleDTO
    reporting error FailureMessage
    transitions from "ReadyToWork" to "Done"
    emitting event ServerSideProcessingComplete
    compensated by undoSomethingOnServerSide
  operation undoSomethingOnServerSide with responsibility STATE_TRANSITION_OPERATION
    expecting payload D<string>  
    delivering payload SampleDTOOpaque structured as JSON_SCHEMA
    transitions from "Done" to "ReadyToWork"
 receives
    event SomethingHasHappened
  
API provider HelloWorldAPIProvider
  offers HelloWorldEndpoint

API client HelloWorldAPIClient
  consumes HelloWorldEndpoint
  
flow SampleFlow 
flow CombinedFlow
  event SomethingHasHappened triggers command doSomethingOnServerSide
  command doSomethingOnServerSide emits event ServerSideProcessingComplete
  
  event FailureMessage triggers command undoSomethingOnServerSide

scenario SampleIntegrationRequirement 
  when "AConditionArises"
  an "API Client"
  wants to "perform action or process data"
  so that "business goals are met"
  
IPA