Skip to content

Commit

Permalink
Correct ActC schema regarding additionalProperties spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
e-backmark-ericsson committed Jan 4, 2024
1 parent f53dc74 commit 001e815
Show file tree
Hide file tree
Showing 18 changed files with 325 additions and 61 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ help: ## Show this help.
@egrep -h '\s##\s' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m %-30s\033[0m %s\n", $$1, $$2}'

.PHONY: tests
test: ## Run all document related checks found in tox: pytest, jsonformat, validate, jsonschema
tox run -e pytest,jsonformat,validate,jsonschema
test: ## Run all document related checks found in tox: pytest, jsonformat, validate
tox run -e pytest,jsonformat,validate

.PHONY: generate_docs
generate_docs: ## Generate the Markdown files based on the YAML definitions
Expand Down
2 changes: 1 addition & 1 deletion definitions/EiffelActivityCanceledEvent/1.0.0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ required:
- meta
- data
- links
additionalProperties: false
additonalProperties: false
_links:
ACTIVITY_EXECUTION:
description: Declares the activity execution that was canceled.
Expand Down
2 changes: 1 addition & 1 deletion definitions/EiffelActivityCanceledEvent/1.1.0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ required:
- meta
- data
- links
additionalProperties: false
additonalProperties: false
_links:
ACTIVITY_EXECUTION:
description: Declares the activity execution that was canceled.
Expand Down
2 changes: 1 addition & 1 deletion definitions/EiffelActivityCanceledEvent/2.0.0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ required:
- meta
- data
- links
additionalProperties: false
additonalProperties: false
_links:
ACTIVITY_EXECUTION:
description: Declares the activity execution that was canceled.
Expand Down
2 changes: 1 addition & 1 deletion definitions/EiffelActivityCanceledEvent/3.0.0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ required:
- meta
- data
- links
additionalProperties: false
additonalProperties: false
_links:
ACTIVITY_EXECUTION:
description: Declares the activity execution that was canceled.
Expand Down
2 changes: 1 addition & 1 deletion definitions/EiffelActivityCanceledEvent/3.1.0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ required:
- meta
- data
- links
additionalProperties: false
additonalProperties: false
_links:
ACTIVITY_EXECUTION:
description: Declares the activity execution that was canceled.
Expand Down
2 changes: 1 addition & 1 deletion definitions/EiffelActivityCanceledEvent/3.2.0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ required:
- meta
- data
- links
additionalProperties: false
additonalProperties: false
_links:
ACTIVITY_EXECUTION:
description: Declares the activity execution that was canceled.
Expand Down
121 changes: 121 additions & 0 deletions definitions/EiffelActivityCanceledEvent/4.0.0.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
---
$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:
$ref: ../EiffelCustomDataProperty/1.0.0.yml
additionalProperties: false
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 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: 4.0.0
changes: Fix bug in schema regarding additionalProperties (see [Issue 376](https://github.com/eiffel-community/eiffel/issues/376)).
- version: 3.2.0
introduced_in: edition-arica
changes: Add schema URL to the meta object (see [Issue 280](https://github.com/eiffel-community/eiffel/issues/280)).
- version: 3.1.0
introduced_in: 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
changes: Improved information integrity protection (see [Issue
185](https://github.com/eiffel-community/eiffel/issues/185)).
- version: 2.0.0
introduced_in: edition-agen
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
changes: Multiple links of type FLOW_CONTEXT allowed.
- version: 1.0.0
introduced_in: edition-bordeaux
changes: Initial version.
_examples:
- title: Simple example
url: ../examples/events/EiffelActivityCanceledEvent/simple.json
3 changes: 2 additions & 1 deletion eiffel-vocabulary/EiffelActivityCanceledEvent.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!---
This file was generated from ../definitions/EiffelActivityCanceledEvent/3.2.0.yml.
This file was generated from ../definitions/EiffelActivityCanceledEvent/4.0.0.yml.
See that file for a copyright notice.
--->

Expand Down Expand Up @@ -177,6 +177,7 @@ __Description:__ A URI pointing at a location from where the schema used when cr

| Version | Introduced in | Changes |
| ------- | ------------- | ------- |
| 4.0.0 | Not yet released in an edition | Fix bug in schema regarding additionalProperties (see [Issue 376](https://github.com/eiffel-community/eiffel/issues/376)). |
| 3.2.0 | [edition-arica](../../../tree/edition-arica) | Add schema URL to the meta object (see [Issue 280](https://github.com/eiffel-community/eiffel/issues/280)). |
| 3.1.0 | [edition-lyon](../../../tree/edition-lyon) | Add links.domainId member (see [Issue 233](https://github.com/eiffel-community/eiffel/issues/233)). |
| 3.0.0 | [edition-agen](../../../tree/edition-agen) | Improved information integrity protection (see [Issue 185](https://github.com/eiffel-community/eiffel/issues/185)). |
Expand Down
2 changes: 1 addition & 1 deletion schemas/EiffelActivityCanceledEvent/1.0.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -152,5 +152,5 @@
"data",
"links"
],
"additionalProperties": false
"additonalProperties": false
}
2 changes: 1 addition & 1 deletion schemas/EiffelActivityCanceledEvent/1.1.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -152,5 +152,5 @@
"data",
"links"
],
"additionalProperties": false
"additonalProperties": false
}
2 changes: 1 addition & 1 deletion schemas/EiffelActivityCanceledEvent/2.0.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -136,5 +136,5 @@
"data",
"links"
],
"additionalProperties": false
"additonalProperties": false
}
2 changes: 1 addition & 1 deletion schemas/EiffelActivityCanceledEvent/3.0.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -178,5 +178,5 @@
"data",
"links"
],
"additionalProperties": false
"additonalProperties": false
}
2 changes: 1 addition & 1 deletion schemas/EiffelActivityCanceledEvent/3.1.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -181,5 +181,5 @@
"data",
"links"
],
"additionalProperties": false
"additonalProperties": false
}
2 changes: 1 addition & 1 deletion schemas/EiffelActivityCanceledEvent/3.2.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -184,5 +184,5 @@
"data",
"links"
],
"additionalProperties": false
"additonalProperties": false
}
Loading

0 comments on commit 001e815

Please sign in to comment.