Skip to content

Added CompositionDefined documentation. #18

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
merged 1 commit into from
Jun 14, 2016
Merged

Added CompositionDefined documentation. #18

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 16 additions & 0 deletions eiffel-vocabulary/EiffelCompositionDefinedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)