Skip to content

update(link): Relax link schemas to support domain-level identifiers #292

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

Open
xibz wants to merge 1 commit into
base: main
Choose a base branch
from
+100 −61
Open

update(link): Relax link schemas to support domain-level identifiers #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 12 additions & 8 deletions schemas/links/embeddedlinkend.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://cdevents.dev/0.6.0-draft/schema/links/embeddedlinkend",
"type": "object",
"additionalProperties": false,
"properties": {
"linkType": {
"type": "string",
"enum": [
"END"
]
"enum": ["END"]
},
"from": {
"description": "When consuming a CDEvent, you are consuming a parent event. So, when looking at the 'from' key, this is the parent's parent.",
"description": "Identifies the upstream entity of the END link. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
},
"required": [
"contextId"
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"tags": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"linkType"
]
Expand Down
21 changes: 13 additions & 8 deletions schemas/links/embeddedlinkpath.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,40 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://cdevents.dev/0.6.0-draft/schema/links/embeddedlinkpath",
"type": "object",
"additionalProperties": false,
"properties": {
"linkType": {
"type": "string",
"enum": [
"PATH"
]
"enum": ["PATH"]
},
"from": {
"description": "When consuming a CDEvent, you are consuming a parent event. So, when looking at the 'from' key, this is the parent's parent.",
"description": "Identifies the upstream parent in the path. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
},
"required": [
"contextId"
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"tags": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"linkType",
"from"
]
}

21 changes: 14 additions & 7 deletions schemas/links/embeddedlinkrelation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,41 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://cdevents.dev/0.6.0-draft/schema/links/embeddedlinkrelation",
"type": "object",
"additionalProperties": false,
"properties": {
"linkType": {
"type": "string",
"enum": [
"RELATION"
]
"enum": ["RELATION"]
},
"linkKind": {
"type": "string",
"minLength": 1
},
"target": {
"description": "",
"description": "Identifies the target of the relation. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
}
},
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"tags": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"linkType",
"linkKind",
Expand Down
37 changes: 23 additions & 14 deletions schemas/links/linkend.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,67 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://cdevents.dev/0.6.0-draft/schema/links/linkend",
"type": "object",
"additionalProperties": false,
"properties": {
"chainId": {
"description": "This represents the full lifecycles of a series of events in CDEvents",
"description": "Represents the lifecycle grouping of a series of related events.",
"type": "string",
"minLength": 1
},
"linkType": {
"description": "The type associated with the link. In this case, 'END', suggesting the end of some CI/CD lifecycle",
"description": "The type associated with the link. In this case, 'END', suggesting the end of some CI/CD lifecycle.",
"type": "string",
"enum": [
"END"
]
"enum": ["END"]
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"from": {
"description": "This is the context ID of the producing CDEvent.",
"description": "Identifies the producing entity of the END link. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
},
"required": [
"contextId"
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"end": {
"description": "This is the context ID of the final CDEvent in the chain",
"description": "Identifies the final entity in the lifecycle. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
},
"required": [
"contextId"
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"tags": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"chainId",
"linkType",
"timestamp",
"from",
Expand Down
36 changes: 23 additions & 13 deletions schemas/links/linkrelation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://cdevents.dev/0.6.0-draft/schema/links/linkrelation",
"type": "object",
"additionalProperties": false,
"properties": {
"chainId": {
"description": "This represents the full lifecycles of a series of events in CDEvents",
"description": "Represents the lifecycle grouping of a series of related events.",
"type": "string",
"minLength": 1
},
"linkType": {
"type": "string",
"enum": [
"RELATION"
]
"enum": ["RELATION"]
},
"linkKind": {
"type": "string",
Expand All @@ -22,43 +22,53 @@
"format": "date-time"
},
"source": {
"description": "",
"description": "Identifies the source of the relation. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
},
"required": [
"contextId"
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"target": {
"description": "",
"description": "Identifies the target of the relation. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
},
"required": [
"contextId"
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"tags": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"chainId",
"linkType",
"timestamp",
"source",
"target"
]
}

26 changes: 15 additions & 11 deletions schemas/links/linkstart.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,51 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://cdevents.dev/0.6.0-draft/schema/links/linkstart",
"type": "object",
"additionalProperties": false,
"properties": {
"chainId": {
"description": "This represents the full lifecycles of a series of events in CDEvents",
"description": "Represents the lifecycle grouping of a series of related events.",
"type": "string",
"minLength": 1
},
"linkType": {
"description": "The type associated with the link. In this case, 'START', suggesting the start of some CI/CD lifecycle",
"description": "The type associated with the link. In this case, 'START', suggesting the start of some lifecycle.",
"type": "string",
"enum": [
"START"
]
"enum": ["START"]
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"start": {
"description": "This is the context ID of the starting CDEvent in the chain.",
"description": "Identifies the starting point of the link. May reference a CDEvent context ID, a domain execution ID, or both.",
"type": "object",
"additionalProperties": false,
"properties": {
"contextId": {
"type": "string",
"minLength": 1
},
"domainId": {
"type": "string",
"minLength": 1
}
},
"required": [
"contextId"
"anyOf": [
{ "required": ["contextId"] },
{ "required": ["domainId"] }
]
},
"tags": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"chainId",
"linkType",
"timestamp",
"start"
]
}