3.2.0.yml

# 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#
_name: EiffelCompositionDefinedEvent
_version: 3.2.0
_abbrev: CD
_description: 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.
type: object
properties:
  meta:
    $ref: ../EiffelMetaProperty/3.0.0.yml
  data:
    type: object
    properties:
      name:
        _description: The name of the composition.
        type: string
      version:
        _description: The version of the composition, if any. This
          is in a sense redundant, as relationships between compositions
          can be tracked via the __PREVIOUS_VERSION__ link type, but
          can be used for improved clarity and semantics.
        type: string
      customData:
        type: array
        items:
          $ref: ../EiffelCustomDataProperty/1.0.0.yml
    required:
      - name
    additionalProperties: false
  links:
    type: array
    items:
      $ref: ../EiffelEventLink/1.1.1.yml
required:
  - meta
  - data
  - links
additionalProperties: false
_links:
  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
  ELEMENT:
    description: Identifies an element and/or sub-composition of this
      composition. The latter is particularly useful for documenting
      large and potentially decentralized compositions, and may be
      used to reduce the need to repeat large compositions in which
      only small parts are subject to frequent change.
    required: false
    multiple: true
    targets:
      any_type: false
      types:
        - EiffelArtifactCreatedEvent
        - EiffelCompositionDefinedEvent
        - EiffelSourceChangeCreatedEvent
        - EiffelSourceChangeSubmittedEvent
  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
  PREVIOUS_VERSION:
    description: Identifies a latest previous version (there may be
      more than one in case of merges) of the composition.
    required: false
    multiple: true
    targets:
      any_type: false
      types:
        - EiffelCompositionDefinedEvent
_history:
  - version: 3.2.0
    introduced_in: edition-lyon
    changes: Add links.domainId member (see [Issue 233](https://github.com/eiffel-community/eiffel/issues/233)).
  - version: 3.1.0
    introduced_in: edition-paris
    changes: Added SCC as valid target for ELEMENT links (see [Issue
      218](https://github.com/eiffel-community/eiffel/issues/218))
  - 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/EiffelCompositionDefinedEvent/simple.json