From 64055a7d0d7c089fce1e7ac498da27a010f3c320 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Thu, 9 Jun 2016 11:30:39 +0200 Subject: [PATCH] Added CompositionDefined documentation. --- README.md | 2 +- .../EiffelCompositionDefinedEvent.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 eiffel-vocabulary/EiffelCompositionDefinedEvent.md diff --git a/README.md b/README.md index 0dcf4f5c..33164d38 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ __IMPORTANT NOTICE:__ The contents of this repository currectly reflect a __DRAF 1. [EiffelConfidenceLevelModifiedEvent](./eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) 1. EiffelDocumentationCreatedEvent 1. EiffelEnvironmentDefinedEvent - 1. EiffelCompositionDefinedEvent + 1. [EiffelCompositionDefinedEvent](./eiffel-vocabulary/EiffelCompositionDefinedEvent.md) 1. EiffelSourceChangeCreatedEvent 1. EiffelSourceChangeSubmittedEvent 1. EiffelFlowContextDefinedEvent diff --git a/eiffel-vocabulary/EiffelCompositionDefinedEvent.md b/eiffel-vocabulary/EiffelCompositionDefinedEvent.md new file mode 100644 index 00000000..2c22d314 --- /dev/null +++ b/eiffel-vocabulary/EiffelCompositionDefinedEvent.md @@ -0,0 +1,16 @@ +# EiffelCompositionDefinedEvent +The EiffelCompositionDefinedEvent declares a composition of items (artifacts, sources and other compositions) has been defined, typically with the purpose of enabling further downstream artifacts to be generated. + +## Data Members +### data.name +__Type:__ String +__Required:__ Yes +__Description:__ The name of the composition. + +### data.version +__Type:__ String +__Required:__ No +__Description:__ The version of the composition, if any. This is in a sense redundant, as relationships between compositions can be tracked via __links.previousVersions__, but can be used for improved clarity and semantics. + +## Examples +* [Simple example](https://github.com/Ericsson/eiffel-examples/blob/master/events/EiffelCompositionDefinedEvent/simple.json) \ No newline at end of file