Skip to content
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

Jump to bottom

Made meta.source and meta.source.domainId optional #116

Merged
merged 1 commit into from
Feb 23, 2017
Merged

Made meta.source and meta.source.domainId optional #116

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions eiffel-syntax-and-usage/the-meta-object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ __Description:__ Any tags or keywords associated with the events, for searchabil
### meta.source
__Type:__ Object
__Format:__
__Required:__ Yes
__Description:__ A description of the event sender. Primarily for traceability purposes.
__Required:__ No
__Description:__ A description of the source of the event. This object is primarily for traceability purposes, and while optional, some form of identification of the source is __HIGHLY RECOMMENDED__. It offers multiple methods of identifying the source of the event, techniques which may be select from based on the technology domain and needs in any particular use case.

#### meta.source.domainId
__Type:__ String
__Format:__ Free text
__Required:__ Yes
__Required:__ No
__Description:__ Identifies the domain that produced an event. A domain is an infrastructure topological concept, which may or may not corresponds to an organization or product structures. A good example would be Java packages notation, ex. com.mycompany.product.component or mycompany.site.division. Also, keep in mind that all names are more or less prone to change. Particularly, it is recommended to avoid organizational names or site names, as organizations tend to be volatile and development is easily relocated. Relatively speaking, product and component names tend to be more stable and are therefore encouraged, while code names may be an option. You need to decide what is the most sensible option in your case.

#### meta.source.host
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelActivityCanceledEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelActivityCanceledEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"reason": "Made irrelevant by newly scheduled execution."
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelActivityFinishedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelActivityFinishedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"outcome": {
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelActivityStartedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelActivityStartedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"executionUri": "https://my.jenkins.host/myJob/43",
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelActivityTriggeredEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"id": "e1e93f13-7c3c-4f17-9753-ebf0c86ff1c2",
"type": "EiffelActivityTriggeredEvent",
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
}
"time": 1234567890
},
"data": {
"name": "Component X Build",
Expand Down
3 changes: 0 additions & 3 deletions examples/events/EiffelAnnouncementPublishedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
"type": "EiffelAnnouncementPublishedEvent",
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
Expand Down
1 change: 0 additions & 1 deletion examples/events/EiffelArtifactCreatedEvent/backend.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
Expand Down
2 changes: 1 addition & 1 deletion examples/events/EiffelArtifactCreatedEvent/dependent.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
"uri": "https://ci.internal.myorg.org/ArtifactBuilder/info"
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
Expand Down
6 changes: 5 additions & 1 deletion examples/events/EiffelArtifactCreatedEvent/interface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
"serializer": {
"groupId": "com.mycompany.pipeline-tools",
"artifactId": "eiffel-serializer",
"version": "57"
}
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
Expand Down
1 change: 0 additions & 1 deletion examples/events/EiffelArtifactCreatedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain",
"serializer": {
"groupId": "com.mycompany.tools",
"artifactId": "eiffel-serializer",
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelArtifactPublishedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelArtifactPublishedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"locations": [
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelCompositionDefinedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelCompositionDefinedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"name": "myCompositionName",
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelConfidenceLevelModifiedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelConfidenceLevelModifiedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"name": "stable",
Expand Down
2 changes: 1 addition & 1 deletion examples/events/EiffelEnvironmentDefinedEvent/host.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
"host": "envmanager.internal.myorg.org"
}
},
"data": {
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelEnvironmentDefinedEvent/image.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelEnvironmentDefinedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"name": "John's Docker Image",
Expand Down
2 changes: 1 addition & 1 deletion examples/events/EiffelEnvironmentDefinedEvent/uri.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
"name": "Environment Manager"
}
},
"data": {
Expand Down
3 changes: 0 additions & 3 deletions examples/events/EiffelFlowContextDefinedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
"type": "EiffelFlowContextDefinedEvent",
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelIssueVerifiedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelIssueVerifiedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"issues": [
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelSourceChangeCreatedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelSourceChangeCreatedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"gitIdentifier": {
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelSourceChangeSubmittedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelSourceChangeSubmittedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"svnIdentifier": {
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelTestCaseFinishedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelTestCaseFinishedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"outcome": {
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelTestCaseStartedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelTestCaseStartedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"testCase": {
Expand Down
3 changes: 0 additions & 3 deletions examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
"type": "EiffelTestExecutionRecipeCollectionCreatedEvent",
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
Expand Down
5 changes: 1 addition & 4 deletions examples/events/EiffelTestSuiteFinishedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
"type": "EiffelTestSuiteFinishedEvent",
"version": "1.0.0",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0",
"source": {
"domainId": "example.domain"
}
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
"outcome": {
Expand Down
3 changes: 0 additions & 3 deletions examples/events/EiffelTestSuiteStartedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
"type": "EiffelTestSuiteStartedEvent",
"version": "1.0.0",
"time": 1234567890,
"source": {
"domainId": "example.domain"
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
"data": {
Expand Down
6 changes: 1 addition & 5 deletions schemas/EiffelActivityCanceledEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,14 @@
"type": "string"
}
},
"required": [
"domainId"
],
"additionalProperties": false
}
},
"required": [
"id",
"type",
"version",
"time",
"source"
"time"
],
"additionalProperties": false
},
Expand Down
6 changes: 1 addition & 5 deletions schemas/EiffelActivityFinishedEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,14 @@
"type": "string"
}
},
"required": [
"domainId"
],
"additionalProperties": false
}
},
"required": [
"id",
"type",
"version",
"time",
"source"
"time"
],
"additionalProperties": false
},
Expand Down
6 changes: 1 addition & 5 deletions schemas/EiffelActivityStartedEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,14 @@
"type": "string"
}
},
"required": [
"domainId"
],
"additionalProperties": false
}
},
"required": [
"id",
"type",
"version",
"time",
"source"
"time"
],
"additionalProperties": false
},
Expand Down
6 changes: 1 addition & 5 deletions schemas/EiffelActivityTriggeredEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,14 @@
"type": "string"
}
},
"required": [
"domainId"
],
"additionalProperties": false
}
},
"required": [
"id",
"type",
"version",
"time",
"source"
"time"
],
"additionalProperties": false
},
Expand Down
6 changes: 1 addition & 5 deletions schemas/EiffelAnnouncementPublishedEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,14 @@
"type": "string"
}
},
"required": [
"domainId"
],
"additionalProperties": false
}
},
"required": [
"id",
"type",
"version",
"time",
"source"
"time"
],
"additionalProperties": false
},
Expand Down