Completed description of links object #2
Conversation
Added all missing links to the-links-object.md. Also removed Schema placeholder headings from event descriptions; the intent is to add schemas to separate repository.
|
Overall good clarification links however we should spend sometime on Legal Targets and Optional lists and how (if?) are we going to validate these. JsonSchema introduces very severe limitations on what type of checks we can employ. |
| @@ -6,6 +6,3 @@ The EiffelActivityDequeuedEvent signals that an activity previously queued for e | |||
| __Type:__ String | |||
| __Required:__ No | |||
| __Description:__ Any human readable information as to the reason for dequeueing. | |||
|
|
|||
There was a problem hiding this comment.
I am presuming this is because of schema repository?
There was a problem hiding this comment.
I'm not following?
Edit: Ah, schema repository as in eiffel-schemas? (I was thinking Avro...) Yes. Let's add links to examples and schemas later.
|
I don't expect target validation using schemas. A dispatcher (Remrem) COULD check target validity, but even that is uncertain from a protocol definition point of view. It's important to separate these concerns: the protocol should be very clear on what messages shall look like - to what extent a certain implementation is able/willing to validate that is another matter. |
links.environment should have been links.artifact.
| __Legal targets:__ [EiffelEnvironmentDefinedEvent](../eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ||
| __Description:__ Identifies the environment in which an event occurred, e.g. in which environment an artifact was built. | ||
|
|
||
| ### links.environment |
There was a problem hiding this comment.
This should be links.artifact
| [EiffelActivityFinishedEvent](../eiffel-vocabulary/EiffelActivityFinishedEvent) | ||
| __Optional in:__ None | ||
| __Legal targets:__ [EiffelActivityQueuedEvent](../eiffel-vocabulary/EiffelActivityQueuedEvent.md) | ||
| __Description:__ Declares the activity execution the event relates to. In other words, [EiffelActivityQueuedEvent](../eiffel-vocabulary/EiffelActivityQueuedEvent.md) acts as a handle for the activity execution. |
There was a problem hiding this comment.
The relation between links.activityExecution and links.context needs to be clarified.
There was a problem hiding this comment.
Pushed a stab as explaining this difference. That being said, it's not a given that these should be separate link types. It would be entirely possible to merge context, activityExecution, testCaseExecution and/or testSuiteExecution - in each case, the meaning could be implicitly derived from the target. I'm not really a fan of that, however, I'd like explicit semantics wherever possible.
After renaming links.previous to links.previousVersions, it makes little sense to keep previous activity executions in there. Actually identifying the ActivityQueued of the latest previous execution may not be trivial, however, so it should still be optional (besides, there's always a first time).
| __Required in:__ None | ||
| __Optional in:__ [EiffelAnnouncementEvent](../eiffel-vocabulary/EiffelAnnouncementEvent.md) | ||
| __Legal targets:__ [EiffelAnnouncementEvent](../eiffel-vocabulary/EiffelAnnouncementEvent.md), | ||
| [EiffelCompositionDefinedEvent](../eiffel-vocabulary/EiffelCompositionDefinedEvent.md) |
There was a problem hiding this comment.
Don't think EiffelCompositionDefinedEvent should be a legal target here.
* Change repository-specific references and links to generic references and links, so that any repository can use these files.
Added all missing links to the-links-object.md.
Also removed Schema placeholder headings from event descriptions;
the intent is to add schemas to separate repository.