-
Notifications
You must be signed in to change notification settings - Fork 61
Add schema URL to the meta object #313
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.
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
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
93a3166
Add schema URL to the meta object (#280)
z-sztrom 81b446e
Merge branch 'eiffel-community:master' into master
z-sztrom 95322b5
Add schema URL to the meta object (#280)
z-sztrom a76d8e7
Merge branch 'master' of https://github.com/z-sztrom/eiffel
z-sztrom 0e4bf6b
Merge branch 'eiffel-community:master' into master
z-sztrom 4ecfe7b
Schema URL added to meta object
z-sztrom fd54a2f
Merge fixed
z-sztrom 0a3e53d
additionalProperties removed from schemaUri.
z-sztrom 758cbf9
Schemas regenerated
z-sztrom 2650530
Issue number fixed (313 -> 280)
z-sztrom File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| $schema: http://json-schema.org/draft-04/schema# | ||
| _abbrev: ActC | ||
| _description: The EiffelActivityCanceledEvent signals that a previously | ||
| triggered activity execution has been canceled _before it has started_. | ||
| This is typically used in queuing situations where a queued execution | ||
| is dequeued. It is recommended that __CAUSE__ links be used to indicate | ||
| the reason. | ||
| type: object | ||
| properties: | ||
| meta: | ||
| $ref: ../EiffelMetaProperty/3.1.0.yml | ||
| data: | ||
| type: object | ||
| properties: | ||
| reason: | ||
| _description: Any human readable information as to the reason | ||
| for dequeueing. | ||
| type: string | ||
| customData: | ||
| type: array | ||
| items: | ||
| type: object | ||
| properties: | ||
| key: | ||
| type: string | ||
| value: {} | ||
| required: | ||
| - key | ||
| - value | ||
| additionalProperties: false | ||
| additionalProperties: false | ||
| links: | ||
| type: array | ||
| items: | ||
| $ref: ../EiffelEventLink/1.1.1.yml | ||
| required: | ||
| - meta | ||
| - data | ||
| - links | ||
| additonalProperties: false | ||
| _links: | ||
| ACTIVITY_EXECUTION: | ||
| description: Declares the activity execution that was canceled. | ||
| In other words, [EiffelActivityTriggeredEvent](../eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ||
| acts as a handle for the activity execution. This differs from | ||
| __CONTEXT__. In __ACTIVITY_EXECUTION__ the source carries information | ||
| pertaining to the target (i.e. the activity started, finished | ||
| or was canceled). In __CONTEXT__, on the other hand, the source | ||
| constitutes a subset of the target (e.g. this test case was executed | ||
| as part of that activity or test suite). | ||
| required: true | ||
| multiple: false | ||
| targets: | ||
| any_type: false | ||
| types: | ||
| - EiffelActivityTriggeredEvent | ||
| CAUSE: | ||
| description: While for most events it is recommended that __CAUSE__ | ||
| SHOULD not be used in conjunction with __CONTEXT__, EiffelActivityCanceledEvent | ||
| is a special case as it represents a deviation from previous | ||
| intention. Therefore it is recommended that __CAUSE__ always | ||
| be included where applicable. | ||
| required: false | ||
| multiple: true | ||
| targets: | ||
| any_type: true | ||
| types: [] | ||
| CONTEXT: | ||
| description: Identifies the activity or test suite of which this | ||
| event constitutes a part. | ||
| required: false | ||
| multiple: false | ||
| targets: | ||
| any_type: false | ||
| types: | ||
| - EiffelActivityTriggeredEvent | ||
| - EiffelTestSuiteStartedEvent | ||
| FLOW_CONTEXT: | ||
| description: 'Identifies the flow context of the event: which is | ||
| the continuous integration and delivery flow in which this occurred | ||
| – e.g. which product, project, track or version this is applicable | ||
| to.' | ||
| required: false | ||
| multiple: true | ||
| targets: | ||
| any_type: false | ||
| types: | ||
| - EiffelFlowContextDefinedEvent | ||
| _history: | ||
| - version: 3.2.0 | ||
| introduced_in: 'No edition set' | ||
| changes: Add schema URL to the meta object (see [Issue 313](https://github.com/eiffel-community/eiffel/issues/313)). | ||
| - version: 3.2.0 | ||
| introduced_in: 'No edition set' | ||
| changes: Add schema URL to the meta object (see [Issue 313](https://github.com/eiffel-community/eiffel/issues/313)). | ||
| - version: 3.1.0 | ||
| introduced_in: '[edition-lyon](../../../tree/edition-lyon)' | ||
| changes: Add links.domainId member (see [Issue 233](https://github.com/eiffel-community/eiffel/issues/233)). | ||
| - version: 3.0.0 | ||
| introduced_in: '[edition-agen](../../../tree/edition-agen)' | ||
| changes: Improved information integrity protection (see [Issue | ||
| 185](https://github.com/eiffel-community/eiffel/issues/185)). | ||
| - version: 2.0.0 | ||
| introduced_in: '[dc5ec6f](../../../blob/dc5ec6fb87e293eeffe88fdafe698eec0f5a2c89/eiffel-vocabulary/EiffelActivityCanceledEvent.md)' | ||
| changes: Introduced purl identifiers instead of GAVs (see [Issue | ||
| 182](https://github.com/eiffel-community/eiffel/issues/182)) | ||
| - version: 1.1.0 | ||
| introduced_in: '[edition-toulouse](../../../tree/edition-toulouse)' | ||
| changes: Multiple links of type FLOW_CONTEXT allowed. | ||
| - version: 1.0.0 | ||
| introduced_in: '[edition-bordeaux](../../../tree/edition-bordeaux)' | ||
| changes: Initial version. | ||
| _examples: | ||
| - title: Simple example | ||
| url: ../examples/events/EiffelActivityCanceledEvent/simple.json | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| $schema: http://json-schema.org/draft-04/schema# | ||
| _abbrev: ActF | ||
| _description: The EiffelActivityFinishedEvent declares that a previously | ||
| started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md) | ||
| followed by [EiffelActivityStartedEvent](./EiffelActivityStartedEvent.md)) | ||
| has finished. | ||
| type: object | ||
| properties: | ||
| meta: | ||
| $ref: ../EiffelMetaProperty/3.1.0.yml | ||
| data: | ||
| type: object | ||
| properties: | ||
| outcome: | ||
| _description: The outcome of the activity. | ||
| type: object | ||
| properties: | ||
| conclusion: | ||
| _description: |- | ||
| A terse standardized conclusion of the activity, designed to be machine readable. | ||
| SUCCESSFUL signifies that the activity was concluded and the outcome matched expectations. | ||
| UNSUCCESSFUL signifies that the activity was concluded, but the outcome did not match expectations. To exemplify, a compilation job was successfully invoked, but compilation failed. | ||
| FAILED signifies that the activity could not be successfully executed. To exemplify, a compilation could not be invoked, e.g. due to misconfiguration or environment issues. | ||
| ABORTED signifies that the activity was aborted before it could be concluded. | ||
| TIMED_OUT signifies that the activity did not conclude within the allowed time frame. | ||
| INCONCLUSIVE signifies that the outcome of the activity could not be determined. | ||
| type: string | ||
| enum: | ||
| - SUCCESSFUL | ||
| - UNSUCCESSFUL | ||
| - FAILED | ||
| - ABORTED | ||
| - TIMED_OUT | ||
| - INCONCLUSIVE | ||
| description: | ||
| _description: A verbose description of the activity outcome, | ||
| designed to provide human readers with further information. | ||
| type: string | ||
| required: | ||
| - conclusion | ||
| persistentLogs: | ||
| _description: An array of persistent log files generated during | ||
| execution. | ||
| type: array | ||
| items: | ||
| type: object | ||
| properties: | ||
| mediaType: | ||
| _description: The [media type](https://en.wikipedia.org/wiki/Media_type) | ||
| of the URI's payload. Can be used to differentiate | ||
| between various representations of the same log, e.g. | ||
| text/html for human consumption and text/plain or application/json | ||
| for the machine-readable form. | ||
| type: string | ||
| name: | ||
| _description: The name of the log file. | ||
| type: string | ||
| tags: | ||
| _description: Arbitrary tags and keywords that describe | ||
| this log. | ||
| type: array | ||
| items: | ||
| type: string | ||
| uri: | ||
| _description: The URI at which the log can be retrieved. | ||
| type: string | ||
| required: | ||
| - name | ||
| - uri | ||
| additionalProperties: false | ||
| customData: | ||
| type: array | ||
| items: | ||
| type: object | ||
| properties: | ||
| key: | ||
| type: string | ||
| value: {} | ||
| required: | ||
| - key | ||
| - value | ||
| additionalProperties: false | ||
| additionalProperties: false | ||
| required: | ||
| - outcome | ||
| links: | ||
| type: array | ||
| items: | ||
| $ref: ../EiffelEventLink/1.1.1.yml | ||
| required: | ||
| - meta | ||
| - data | ||
| - links | ||
| additionalProperties: false | ||
| _links: | ||
| ACTIVITY_EXECUTION: | ||
| description: Declares the activity execution that was finished. | ||
| In other words, [EiffelActivityTriggeredEvent](../eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ||
| acts as a handle for the activity execution. This differs from | ||
| __CONTEXT__. In __ACTIVITY_EXECUTION__ the source carries information | ||
| pertaining to the target (i.e. the activity started, finished | ||
| or was canceled). In __CONTEXT__, on the other hand, the source | ||
| constitutes a subset of the target (e.g. this test case was executed | ||
| as part of that activity or test suite). | ||
| required: true | ||
| multiple: false | ||
| targets: | ||
| any_type: false | ||
| types: | ||
| - EiffelActivityTriggeredEvent | ||
| CAUSE: | ||
| description: 'Identifies a cause of the event occurring. SHOULD | ||
| not be used in conjunction with __CONTEXT__: individual events | ||
| providing __CAUSE__ within a larger context gives rise to ambiguity. | ||
| It is instead recommended to let the root event of the context | ||
| declare __CAUSE__.' | ||
| required: false | ||
| multiple: true | ||
| targets: | ||
| any_type: true | ||
| types: [] | ||
| CONTEXT: | ||
| description: Identifies the activity or test suite of which this | ||
| event constitutes a part. | ||
| required: false | ||
| multiple: false | ||
| targets: | ||
| any_type: false | ||
| types: | ||
| - EiffelActivityTriggeredEvent | ||
| - EiffelTestSuiteStartedEvent | ||
| FLOW_CONTEXT: | ||
| description: 'Identifies the flow context of the event: which is | ||
| the continuous integration and delivery flow in which this occurred | ||
| – e.g. which product, project, track or version this is applicable | ||
| to.' | ||
| required: false | ||
| multiple: true | ||
| targets: | ||
| any_type: false | ||
| types: | ||
| - EiffelFlowContextDefinedEvent | ||
| _history: | ||
| - version: 3.3.0 | ||
| introduced_in: 'No edition set' | ||
| changes: Add schema URL to the meta object (see [Issue 313](https://github.com/eiffel-community/eiffel/issues/313)). | ||
| - version: 3.2.0 | ||
| introduced_in: '[edition-lyon](../../../tree/edition-lyon)' | ||
| changes: Add links.domainId member (see [Issue 233](https://github.com/eiffel-community/eiffel/issues/233)). | ||
| - version: 3.1.0 | ||
| introduced_in: No edition set | ||
| changes: Add `data.persistentLogs.{mediaType,tags}`. | ||
| - version: 3.0.0 | ||
| introduced_in: '[edition-agen](../../../tree/edition-agen)' | ||
| changes: Improved information integrity protection (see [Issue | ||
| 185](https://github.com/eiffel-community/eiffel/issues/185)). | ||
| - version: 2.0.0 | ||
| introduced_in: '[dc5ec6f](../../../blob/dc5ec6fb87e293eeffe88fdafe698eec0f5a2c89/eiffel-vocabulary/EiffelActivityFinishedEvent.md)' | ||
| changes: Introduced purl identifiers instead of GAVs (see [Issue | ||
| 182](https://github.com/eiffel-community/eiffel/issues/182)) | ||
| - version: 1.1.0 | ||
| introduced_in: '[edition-toulouse](../../../tree/edition-toulouse)' | ||
| changes: Multiple links of type FLOW_CONTEXT allowed. | ||
| - version: 1.0.0 | ||
| introduced_in: '[edition-bordeaux](../../../tree/edition-bordeaux)' | ||
| changes: Initial version. | ||
| _examples: | ||
| - title: Simple example | ||
| url: ../examples/events/EiffelActivityFinishedEvent/simple.json |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically, this should be a link to the issue (280) and not the PR (313). But I can live with this and we can clean it up when updating
introduced_inas we prepare the release of the Arica edition.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it can help to avoid misunderstanding/confusion, I can fix it on Monday. One sed command can fix that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue number fixed. I hope I didn't break something else:-)