Skip to content

Introduced purls instead of GAVs #195

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

Merged
merged 6 commits into from
Sep 11, 2018
Merged

Introduced purls instead of GAVs #195

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
365bb12
Introduced purls instead of GAVs
d-stahl-ericsson Aug 7, 2018
842e2b3
Fixed GitHub PR review comments.
d-stahl-ericsson Aug 13, 2018
78615a9
Brought event types to front in delivery-interface.svg.
d-stahl-ericsson Aug 17, 2018
d79fc00
Removed obsolete draw.io .xml diagram.
d-stahl-ericsson Aug 17, 2018
e31e59c
Removed GAV references in documentation
d-stahl-ericsson Aug 21, 2018
ccc5814
Fixed version range percent encoding in graphs and examples
d-stahl-ericsson Aug 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 4 additions & 21 deletions eiffel-vocabulary/EiffelActivityCanceledEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,28 +106,10 @@ __Required:__ No
__Description:__ The name of the event sender.

#### meta.source.serializer
__Type:__ Object
__Format:__
__Required:__ No
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) coordinates of the serializer software used to construct the event.

##### meta.source.serializer.groupId
__Type:__ String
__Format:__ groupId
__Required:__ Yes
__Description:__ The groupId of the serializer software.

##### meta.source.serializer.artifactId
__Type:__ String
__Format:__ artifactId
__Required:__ Yes
__Description:__ The artifactId of the serializer software.

##### meta.source.serializer.version
__Type:__ String
__Format:__ version
__Required:__ Yes
__Description:__ The version of the serializer software.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ The identity of the serializer software used to construct the event, in [purl format](https://github.com/package-url/purl-spec).

#### meta.source.uri
__Type:__ String
Expand Down Expand Up @@ -162,6 +144,7 @@ __Description:__ The encrypted digest. The cryptographic hash function and the d
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see [Issue 182](https://github.com/eiffel-community/eiffel/issues/182)) |
| 1.1.0 | [edition-toulouse](../../../tree/edition-toulouse) | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

Expand Down
25 changes: 4 additions & 21 deletions eiffel-vocabulary/EiffelActivityFinishedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,28 +138,10 @@ __Required:__ No
__Description:__ The name of the event sender.

#### meta.source.serializer
__Type:__ Object
__Format:__
__Required:__ No
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) coordinates of the serializer software used to construct the event.

##### meta.source.serializer.groupId
__Type:__ String
__Format:__ groupId
__Required:__ Yes
__Description:__ The groupId of the serializer software.

##### meta.source.serializer.artifactId
__Type:__ String
__Format:__ artifactId
__Required:__ Yes
__Description:__ The artifactId of the serializer software.

##### meta.source.serializer.version
__Type:__ String
__Format:__ version
__Required:__ Yes
__Description:__ The version of the serializer software.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ The identity of the serializer software used to construct the event, in [purl format](https://github.com/package-url/purl-spec).

#### meta.source.uri
__Type:__ String
Expand Down Expand Up @@ -194,6 +176,7 @@ __Description:__ The encrypted digest. The cryptographic hash function and the d
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see [Issue 182](https://github.com/eiffel-community/eiffel/issues/182)) |
| 1.1.0 | [edition-toulouse](../../../tree/edition-toulouse) | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

Expand Down
25 changes: 4 additions & 21 deletions eiffel-vocabulary/EiffelActivityStartedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,28 +127,10 @@ __Required:__ No
__Description:__ The name of the event sender.

#### meta.source.serializer
__Type:__ Object
__Format:__
__Required:__ No
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) coordinates of the serializer software used to construct the event.

##### meta.source.serializer.groupId
__Type:__ String
__Format:__ groupId
__Required:__ Yes
__Description:__ The groupId of the serializer software.

##### meta.source.serializer.artifactId
__Type:__ String
__Format:__ artifactId
__Required:__ Yes
__Description:__ The artifactId of the serializer software.

##### meta.source.serializer.version
__Type:__ String
__Format:__ version
__Required:__ Yes
__Description:__ The version of the serializer software.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ The identity of the serializer software used to construct the event, in [purl format](https://github.com/package-url/purl-spec).

#### meta.source.uri
__Type:__ String
Expand Down Expand Up @@ -183,6 +165,7 @@ __Description:__ The encrypted digest. The cryptographic hash function and the d
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see [Issue 182](https://github.com/eiffel-community/eiffel/issues/182)) |
| 1.1.0 | [edition-toulouse](../../../tree/edition-toulouse) | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

Expand Down
25 changes: 4 additions & 21 deletions eiffel-vocabulary/EiffelActivityTriggeredEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,28 +134,10 @@ __Required:__ No
__Description:__ The name of the event sender.

#### meta.source.serializer
__Type:__ Object
__Format:__
__Required:__ No
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) coordinates of the serializer software used to construct the event.

##### meta.source.serializer.groupId
__Type:__ String
__Format:__ groupId
__Required:__ Yes
__Description:__ The groupId of the serializer software.

##### meta.source.serializer.artifactId
__Type:__ String
__Format:__ artifactId
__Required:__ Yes
__Description:__ The artifactId of the serializer software.

##### meta.source.serializer.version
__Type:__ String
__Format:__ version
__Required:__ Yes
__Description:__ The version of the serializer software.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ The identity of the serializer software used to construct the event, in [purl format](https://github.com/package-url/purl-spec).

#### meta.source.uri
__Type:__ String
Expand Down Expand Up @@ -190,6 +172,7 @@ __Description:__ The encrypted digest. The cryptographic hash function and the d
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see [Issue 182](https://github.com/eiffel-community/eiffel/issues/182)) |
| 1.1.0 | [edition-toulouse](../../../tree/edition-toulouse) | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

Expand Down
25 changes: 4 additions & 21 deletions eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,28 +122,10 @@ __Required:__ No
__Description:__ The name of the event sender.

#### meta.source.serializer
__Type:__ Object
__Format:__
__Required:__ No
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) coordinates of the serializer software used to construct the event.

##### meta.source.serializer.groupId
__Type:__ String
__Format:__ groupId
__Required:__ Yes
__Description:__ The groupId of the serializer software.

##### meta.source.serializer.artifactId
__Type:__ String
__Format:__ artifactId
__Required:__ Yes
__Description:__ The artifactId of the serializer software.

##### meta.source.serializer.version
__Type:__ String
__Format:__ version
__Required:__ Yes
__Description:__ The version of the serializer software.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ The identity of the serializer software used to construct the event, in [purl format](https://github.com/package-url/purl-spec).

#### meta.source.uri
__Type:__ String
Expand Down Expand Up @@ -178,6 +160,7 @@ __Description:__ The encrypted digest. The cryptographic hash function and the d
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see [Issue 182](https://github.com/eiffel-community/eiffel/issues/182)) |
| 1.1.0 | [edition-toulouse](../../../tree/edition-toulouse) | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

Expand Down
99 changes: 20 additions & 79 deletions eiffel-vocabulary/EiffelArtifactCreatedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,40 +19,26 @@
The EiffelArtifactCreatedEvent declares that a software artifact has been created, what its coordinates are, what it contains and how it was created.

## Data Members
### data.gav
__Type:__ Object
__Required:__ Yes
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) of the created artifact.

#### data.gav.groupId
__Type:__ String
__Required:__ Yes
__Description:__ The groupId of the created artifact.

#### data.gav.artifactId
### data.identity
__Type:__ String
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ Yes
__Description:__ The artifactId of the created artifact.

#### data.gav.version
__Type:__ String
__Required:__ Yes
__Description:__ The version of the created artifact.
__Description:__ The identity of the created artifact, in [purl format](https://github.com/package-url/purl-spec).

### data.fileInformation
__Type:__ Object[]
__Required:__ No
__Description:__ A list of the artifact file contents, following the standard established by [Apache Maven](https://maven.apache.org/pom.html).
__Description:__ A list of the artifact file contents. This information is optional and, when included, MAY include a complete or incomplete list of contents. In other words, it may be used to highlight only particular files of interest, such as launcher binaries or other entry-points.

#### data.fileInformation.classifier
#### data.fileInformation.name
__Type:__ String
__Required:__ Yes
__Description:__ The classifier of the file within the artifact. If none, an empty string shall be used.
__Description:__ The name (including relative path from the root of the artifact) on syntax appropriate for the artifact packaging type.
Copy link
Member

@e-backmark-ericsson e-backmark-ericsson Aug 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: '... or syntax ...', right?

Copy link
Contributor Author

@d-stahl-ericsson d-stahl-ericsson Aug 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope. The name should be on appropriate syntax. It's not that the property contains names or syntax.

Copy link
Member

@e-backmark-ericsson e-backmark-ericsson Aug 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True


#### data.fileInformation.extension
__Type:__ String
__Required:__ Yes
__Description:__ The extension of the file within the artifact. If none, an empty string shall be used.
#### data.fileInformation.tags
__Type:__ String[]
__Required:__ No
__Description:__ Any tags associated with the file, to support navigation and identification of items of interest.

### data.buildCommand
__Type:__ String
Expand All @@ -70,44 +56,16 @@ EXACTLY_ONE signifies that a legal composition must contain one and only one imp
AT_LEAST_ONE signifies that a legal composition must contain one or more implementations of this artifact.

### data.implements
__Type:__ Object[]
__Required:__ No
__Description:__ An array of [GAVs](https://maven.apache.org/guides/mini/guide-naming-conventions.html) this artifact implements. The typical use case of this is to identify interfaces implemented by this artifact.

#### data.implements.groupId
__Type:__ String
__Required:__ Yes
__Description:__ The groupId of the implemented artifact.

#### data.implements.artifactId
__Type:__ String
__Required:__ Yes
__Description:__ The artifactId of the implemented artifact.

#### data.implements.version
__Type:__ String
__Required:__ Yes
__Description:__ The version of the implemented artifact. Note that [version range notation](https://docs.oracle.com/middleware/1212/core/MAVEN/maven_version.htm#MAVEN402) is supported.

### data.dependsOn
__Type:__ Object[]
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ An array of [GAVs](https://maven.apache.org/guides/mini/guide-naming-conventions.html) this artifact depends on.

#### data.dependsOn.groupId
__Type:__ String
__Required:__ Yes
__Description:__ The groupId of the dependency.
__Description:__ An array of [purl identified](https://github.com/package-url/purl-spec) entities this artifact implements. The typical use case of this is to identify interfaces implemented by this artifact. While not included in the purl specification itself, the Eiffel protocol allows version range notation according to [Maven syntax](https://docs.oracle.com/middleware/1212/core/MAVEN/maven_version.htm#MAVEN402) to be used for the version component of the package identity. Note that the purl specification always requires the version component to be percent-encoded.

#### data.dependsOn.artifactId
__Type:__ String
__Required:__ Yes
__Description:__ The artifactId of the dependency.

#### data.dependsOn.version
### data.dependsOn
__Type:__ String
__Required:__ Yes
__Description:__ The version of the dependency. Note that [version range notation](https://docs.oracle.com/middleware/1212/core/MAVEN/maven_version.htm#MAVEN402) is supported.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ An array of [purl identified](https://github.com/package-url/purl-spec) entities this artifact depends on. While not included in the purl specification itself, the Eiffel protocol allows version range notation according to [Maven syntax](https://docs.oracle.com/middleware/1212/core/MAVEN/maven_version.htm#MAVEN402) to be used for the version component of the package identity. Note that the purl specification always requires the version component to be percent-encoded.

### data.name
__Type:__ String
Expand Down Expand Up @@ -208,28 +166,10 @@ __Required:__ No
__Description:__ The name of the event sender.

#### meta.source.serializer
__Type:__ Object
__Format:__
__Required:__ No
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) coordinates of the serializer software used to construct the event.

##### meta.source.serializer.groupId
__Type:__ String
__Format:__ groupId
__Required:__ Yes
__Description:__ The groupId of the serializer software.

##### meta.source.serializer.artifactId
__Type:__ String
__Format:__ artifactId
__Required:__ Yes
__Description:__ The artifactId of the serializer software.

##### meta.source.serializer.version
__Type:__ String
__Format:__ version
__Required:__ Yes
__Description:__ The version of the serializer software.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ The identity of the serializer software used to construct the event, in [purl format](https://github.com/package-url/purl-spec).

#### meta.source.uri
__Type:__ String
Expand Down Expand Up @@ -264,6 +204,7 @@ __Description:__ The encrypted digest. The cryptographic hash function and the d
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see [Issue 182](https://github.com/eiffel-community/eiffel/issues/182)) |
| 1.1.0 | [edition-toulouse](../../../tree/edition-toulouse) | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

Expand Down
25 changes: 4 additions & 21 deletions eiffel-vocabulary/EiffelArtifactPublishedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,28 +121,10 @@ __Required:__ No
__Description:__ The name of the event sender.

#### meta.source.serializer
__Type:__ Object
__Format:__
__Required:__ No
__Description:__ The [GAV](https://maven.apache.org/guides/mini/guide-naming-conventions.html) coordinates of the serializer software used to construct the event.

##### meta.source.serializer.groupId
__Type:__ String
__Format:__ groupId
__Required:__ Yes
__Description:__ The groupId of the serializer software.

##### meta.source.serializer.artifactId
__Type:__ String
__Format:__ artifactId
__Required:__ Yes
__Description:__ The artifactId of the serializer software.

##### meta.source.serializer.version
__Type:__ String
__Format:__ version
__Required:__ Yes
__Description:__ The version of the serializer software.
__Format:__ [purl specification](https://github.com/package-url/purl-spec)
__Required:__ No
__Description:__ The identity of the serializer software used to construct the event, in [purl format](https://github.com/package-url/purl-spec).

#### meta.source.uri
__Type:__ String
Expand Down Expand Up @@ -177,6 +159,7 @@ __Description:__ The encrypted digest. The cryptographic hash function and the d
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see [Issue 182](https://github.com/eiffel-community/eiffel/issues/182)) |
| 1.1.0 | [edition-toulouse](../../../tree/edition-toulouse) | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

Expand Down
Loading