### CDEvents Subject Content Example Source: https://cdevents.dev/docs/spec Example of subject content for a taskrun started event. ```json "content" : { "task": "my-task", "uri": "/apis/tekton.dev/v1beta1/namespaces/default/taskruns/my-taskrun-123" } ``` -------------------------------- ### testSuiteRun started Source: https://cdevents.dev/docs/testing Represents a started testSuite execution. ```APIDOC ## EVENT dev.cdevents.testsuiterun.started.0.3.0 ### Description This event represents a started testSuite execution. ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - source from the context - **environment** (Object) - Required - The environment in which this testSuiteRun is running - **testSuite** (Object) - Optional - Definition of the testSuite being executed - **trigger** (Object) - Optional - What triggered this testSuiteRun ``` -------------------------------- ### Define Specification Versioning Examples Source: https://cdevents.dev/docs/primer Examples of schema ID and event version field formats. ```json "$id": "https://cdevents.dev/0.1.1/schema/artifact-packaged-event", ``` ```json "version": "0.1.1" ``` -------------------------------- ### Define Event Versioning Examples Source: https://cdevents.dev/docs/primer Examples of full event version strings used in event types. ```text dev.cdevents.build.queued.0.1.0-draft ``` ```text dev.cdevents.environment.deleted.0.1.0 ``` -------------------------------- ### testCaseRun started Source: https://cdevents.dev/docs/testing Represents a started testCase execution. ```APIDOC ## EVENT dev.cdevents.testcaserun.started.0.3.0 ### Description This event represents a started testCase execution. ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - source from the context - **environment** (Object) - Required - The environment in which this testCaseRun is running - **testCase** (Object) - Optional - Definition of the testCase being executed - **testSuiteRun** (Object) - Optional - A testSuiteRun to associate this testCaseRun with a containing testSuiteRun - **trigger** (Object) - Optional - What triggered this testSuiteRun ``` -------------------------------- ### Full CDEvents Context Example Source: https://cdevents.dev/docs/spec A complete example of a CDEvents context object serialized in JSON. ```json { "context": { "specversion": "0.5.0", "id" : "A234-1234-1234", "source" : "/staging/tekton/", "type" : "dev.cdevents.taskrun.started.0.2.0", "timestamp" : "2018-04-05T17:31:00Z", "schemaUri": "https://myorg.com/cdevents/schema/taskrun-started-1-1-0" } } ``` -------------------------------- ### pipelineRun Started Source: https://cdevents.dev/docs/core Event triggered when a pipelineRun has started execution. ```APIDOC ## dev.cdevents.pipelinerun.started.0.3.0 ### Description Indicates that a pipelineRun has started and is currently running. ### Parameters #### Request Body - **id** (String) - Required - Unique identifier for the pipelineRun - **source** (URI-Reference) - Optional - Source of the event - **pipelineName** (String) - Optional - Name of the pipeline - **url** (URI) - Optional - URL to the pipelineRun ``` -------------------------------- ### taskRun Started Source: https://cdevents.dev/docs/core Event triggered when a taskRun has started execution. ```APIDOC ## dev.cdevents.taskrun.started.0.3.0 ### Description Indicates that a taskRun has started and is currently running. ### Parameters #### Request Body - **id** (String) - Required - Unique identifier for the taskRun - **source** (URI-Reference) - Optional - Source of the event - **taskName** (String) - Optional - Name of the task - **pipelineRun** (Object) - Optional - The pipelineRun that this taskRun belongs to - **url** (URI) - Optional - URL to the taskRun ``` -------------------------------- ### Full CDEvents Example in CloudEvents HTTP Binary Mode Source: https://cdevents.dev/docs/cloudevents-binding This example demonstrates a complete CDEvents payload structured for transport via CloudEvents in HTTP binary mode. It includes both the CloudEvents headers and the JSON body containing the CDEvents context and subject. ```http POST /sink HTTP/1.1 Host: cdevents.example.com ce-specversion: 1.0 ce-type: dev.cdevents.taskrun.started.0.1.1 ce-time: 2018-04-05T17:31:00Z ce-id: A234-1234-1234 ce-source: /staging/tekton/ ce-subject: /namespace/taskrun-123 Content-Type: application/json; charset=utf-8 Content-Length: nnnn { "context": { "specversion": "0.5.0", "id" : "A234-1234-1234", "source" : "/staging/tekton/", "type" : "dev.cdevents.taskrun.started.0.1.1", "timestamp" : "2018-04-05T17:31:00Z", } "subject" : { "id": "/namespace/taskrun-123", "content": { "task": "my-task", "uri": "/apis/tekton.dev/v1beta1/namespaces/default/taskruns/my-taskrun-123" "pipelineRun": { "id": "/somewherelse/pipelinerun-123", "source": "/staging/jenkins/" } } } } ``` -------------------------------- ### Build Started Event Source: https://cdevents.dev/docs/continuous-integration Represents a build task that has been started. This event is typically generated by a CI system or build tool. ```APIDOC ## POST /api/events/build/started ### Description This event represents a Build task that has been started; this build process usually is in charge of producing a binary from source code. ### Method POST ### Endpoint /api/events/build/started ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - Source from the context. ### Request Example ```json { "id": "builds/taskrun123", "source": "staging/tekton" } ``` ### Response #### Success Response (200) - **message** (String) - Confirmation message. #### Response Example ```json { "message": "Build started event received successfully." } ``` ``` -------------------------------- ### CDEvents Custom Data Examples Source: https://cdevents.dev/docs/spec Examples of custom data formats including JSON objects and base64 encoded strings. ```json {"mydata1": "myvalue1"} ``` ```text "VGhlIHZvY2FidWxhcnkgZGVmaW5lcyAqZXZlbnQgdHlwZXMqLCB3aGljaCBhcmUgbWFkZSBvZiAqc3ViamVjdHMqCg==" ``` -------------------------------- ### Schema Version Example Source: https://cdevents.dev/docs/primer/_print The schema ID includes the specification version. This is used to identify the version of the schema being referenced. ```json "$id": "https://cdevents.dev/0.1.1/schema/artifact-packaged-event" ``` -------------------------------- ### Event Version Example Source: https://cdevents.dev/docs/primer/_print The 'version' field within an event payload indicates the specification version it conforms to. This field does not include default or enum values to avoid frequent updates. ```json "version": "0.1.1" ``` -------------------------------- ### CDEvents Subject and Context JSON Source: https://cdevents.dev/docs/spec Example of a CDEvents payload containing both context and subject information. ```json { "context": { "specversion": "0.5.0", "id" : "A234-1234-1234", "source" : "/staging/tekton/", "type" : "dev.cdevents.taskrun.started.0.2.0", "timestamp" : "2018-04-05T17:31:00Z" }, "subject" : { "id": "my-taskrun-123", "content": { "task": "my-task", "uri": "/apis/tekton.dev/v1beta1/namespaces/default/taskruns/my-taskrun-123", "pipelineRun": { "id": "my-distributed-pipelinerun", "source": "/tenant1/tekton/" } } } } ``` -------------------------------- ### CDEvents JSON Custom Data Source: https://cdevents.dev/docs/spec Example of including JSON-formatted data within the customData field. ```json { "context": { (...) }, "subject" : { (...) }, "customData": { "mydata1": { "f1": "f1", "f2": "f2" }, "mydata2": "myvalue1" } } ``` -------------------------------- ### CDEvents Generic Custom Data Source: https://cdevents.dev/docs/spec Example of including non-JSON data in the customData field, requiring base64 encoding and a specified content type. ```json { "context": { (...) }, "subject" : { (...) }, "customData": "PGRhdGE+VkdobElIWnZZMkZpZFd4aGNua2daR1ZtYVc1bGN5QXFaWFpsYm5RZ2RIbHdaWE1xTENCM2FHbGphQ0JoY21VZ2JXRmtaU0J2WmlBcWMzVmlhbVZqZEhNcUNnPT08L2RhdGE+Cg==", "customDataContentType": "application/xml" } ``` -------------------------------- ### Environment Lifecycle Events Source: https://cdevents.dev/docs/continuous-deployment Documentation for events related to the creation, modification, and deletion of deployment environments. ```APIDOC ## dev.cdevents.environment.created.0.3.0 ### Description Represents an environment that has been created. ### Parameters #### Request Body - **id** (String) - Required - Unique identifier for the environment - **source** (URI-Reference) - Optional - Source reference - **name** (String) - Optional - Name of the environment - **url** (String) - Optional - URL of the environment location ## dev.cdevents.environment.modified.0.3.0 ### Description Represents an environment that has been modified. ### Parameters #### Request Body - **id** (String) - Required - Unique identifier for the environment - **source** (URI-Reference) - Optional - Source reference - **name** (String) - Optional - Name of the environment - **url** (String) - Optional - URL of the environment location ## dev.cdevents.environment.deleted.0.3.0 ### Description Represents an environment that has been deleted. ### Parameters #### Request Body - **id** (String) - Required - Unique identifier for the environment - **source** (URI-Reference) - Optional - Source reference - **name** (String) - Optional - Name of the environment - **url** (String) - Optional - URL of the environment location ``` -------------------------------- ### testSuiteRun Subject Source: https://cdevents.dev/docs/testing Defines the schema for tracking the execution of a collection of test cases. ```APIDOC ## testSuiteRun ### Description A testSuiteRun represents the execution of a set of one or more testCaseRuns. ### Fields - **id** (String) - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Source from the context. - **environment** (Object) - The environment in which this testSuiteRun is executing. - **testSuite** (Object) - An optional definition of the testSuite being executed. ``` -------------------------------- ### Artifact Downloaded Event Source: https://cdevents.dev/docs/continuous-integration Represents an artifact that has been downloaded from a registry. ```APIDOC ## `artifact downloaded` ### Description The event represents an artifact that has been downloaded from the registry. The `artifact downloaded` event is preferably produced by the artifact registry. ### Event Type `dev.cdevents.artifact.downloaded.0.2.0` ### Subject `artifact` ### Fields #### id - **Type**: `Purl` - **Description**: See id - **Required**: ✅ - **Examples**: `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427?repository_url=mycr.io/myapp`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` #### source - **Type**: `URI-Reference` - **Description**: See source - **Required**: #### user - **Type**: `String` - **Description**: The user who downloaded from the artifact registry. 1 - **Required**: - **Examples**: `mybot-myapp` ``` -------------------------------- ### Repository Created Event Source: https://cdevents.dev/docs/source-code-version-control Details the 'repository created' event, triggered when a new Source Code Repository is created. ```APIDOC ## Repository Created Event A new Source Code Repository was created to host source code for a project. * Event Type: **`dev.cdevents.repository.created.0.3.0`** * Predicate: created * Subject: `repository` ### Fields | Field | Type | Description | Examples | Required | | ------- | ------------- | ------------------------------------------------------------------------ | -------------------------------------- | -------- | | id | `String` | See id | `an-org/a-repo`, `an-user/a-repo`, `repo123` | ✅ | | source | `URI-Reference` | See source | `my-git.example` | | | name | `String` | The name of the `repository` | `spec`, `community`, `a-repo` | ✅ | | owner | `String` | The owner of the `repository` | `cdevents`, `an-org`, `an-user` | | | url | `URI` | URL to the `repository` | `git://my-git.example/an-org/a-repo` | ✅ | | viewUrl | `URI` | URL for humans to view the content of the `repository` | `https://my-git.example/an-org/a-repo/view` | | ``` -------------------------------- ### testCaseRun Subject Source: https://cdevents.dev/docs/testing Defines the schema for tracking the execution of a single software test case. ```APIDOC ## testCaseRun ### Description A testCaseRun represents the smallest unit of testing, tracking the execution of a test against a software artifact. ### Fields - **id** (String) - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Source from the context. - **environment** (Object) - The environment in which this testCaseRun is executing. - **testCase** (Object) - An optional definition of the testCase being executed. - **testSuiteRun** (Object) - An optional testSuiteRun to associate this testCaseRun with a containing testSuiteRun. ``` -------------------------------- ### Build Queued Event Source: https://cdevents.dev/docs/continuous-integration Represents a build task that has been queued. This event is typically generated by a CI system or build tool. ```APIDOC ## POST /api/events/build/queued ### Description This event represents a Build task that has been queued; this build process usually is in charge of producing a binary from source code. ### Method POST ### Endpoint /api/events/build/queued ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - Source from the context. ### Request Example ```json { "id": "builds/taskrun123", "source": "staging/tekton" } ``` ### Response #### Success Response (200) - **message** (String) - Confirmation message. #### Response Example ```json { "message": "Build queued event received successfully." } ``` ``` -------------------------------- ### Build Finished Event Source: https://cdevents.dev/docs/continuous-integration Represents a Build task that has finished, including its status. ```APIDOC ## `build finished` ### Description This event represents a Build task that has finished. This event will eventually contain the finished status, success, error or failure. ### Event Type `dev.cdevents.build.finished.0.3.0` ### Subject `build` ### Fields #### id - **Type**: `String` - **Description**: See id - **Required**: ✅ - **Examples**: `1234`, `maven123`, `builds/taskrun123` #### source - **Type**: `URI-Reference` - **Description**: See source - **Required**: #### artifactId - **Type**: `Purl` - **Description**: Identifier of the artifact produced by the build - **Required**: `build` - **Examples**: `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` ``` -------------------------------- ### Service Lifecycle Events Source: https://cdevents.dev/docs/continuous-deployment Endpoints for managing service lifecycle events such as deployment, upgrade, rollback, removal, and publication. ```APIDOC ## Service Deployed ### Description Represents a new instance of a service that has been deployed. ### Event Type dev.cdevents.service.deployed.0.3.0 ### Request Body - **id** (String) - Required - Unique identifier for the service - **source** (URI-Reference) - Optional - Source URI - **environment** (Object) - Required - Reference for the environment - **artifactId** (Purl) - Required - Identifier of the artifact deployed ## Service Upgraded ### Description Represents an existing instance of a service that has been upgraded to a new version. ### Event Type dev.cdevents.service.upgraded.0.3.0 ### Request Body - **id** (String) - Required - Unique identifier for the service - **source** (URI-Reference) - Optional - Source URI - **environment** (Object) - Required - Reference for the environment - **artifactId** (Purl) - Required - Identifier of the artifact deployed ## Service Rolledback ### Description Represents an existing instance of a service that has been rolled back to a previous version. ### Event Type dev.cdevents.service.rolledback.0.3.0 ### Request Body - **id** (String) - Required - Unique identifier for the service - **source** (URI-Reference) - Optional - Source URI - **environment** (Object) - Required - Reference for the environment - **artifactId** (Purl) - Required - Identifier of the artifact deployed ## Service Removed ### Description Represents the removal of a previously deployed service instance. ### Event Type dev.cdevents.service.removed.0.3.0 ### Request Body - **id** (String) - Required - Unique identifier for the service - **source** (URI-Reference) - Optional - Source URI - **environment** (Object) - Required - Reference for the environment ## Service Published ### Description Represents an existing instance of a service that has an accessible URL for users. ### Event Type dev.cdevents.service.published.0.3.0 ### Request Body - **id** (String) - Required - Unique identifier for the service - **source** (URI-Reference) - Optional - Source URI - **environment** (Object) - Required - Reference for the environment ``` -------------------------------- ### testSuiteRun finished Source: https://cdevents.dev/docs/testing Represents a finished testSuite execution including outcome and metadata. ```APIDOC ## EVENT dev.cdevents.testsuiterun.finished.0.3.0 ### Description This event represents a finished testSuite execution. The event will contain the outcome and additional metadata as applicable. ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - source from the context - **environment** (Object) - Required - The environment in which this testSuiteRun was running - **outcome** (String) - Required - The outcome of the testSuite execution, one of success, failure, cancel, or error - **severity** (String) - Optional - Severity if the test failed, one of low, medium, high, critical - **reason** (String) - Optional - A reason related to the outcome of the execution - **testSuite** (Object) - Optional - Definition of the testSuite being executed ``` -------------------------------- ### testCaseRun queued Source: https://cdevents.dev/docs/testing Represents when a testCaseRun has been queued for execution. ```APIDOC ## EVENT dev.cdevents.testcaserun.queued.0.3.0 ### Description This event represents when a testCaseRun has been queued for execution and is waiting for preconditions to be fulfilled. ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - source from the context - **environment** (Object) - Required - The environment in which this testCaseRun is queued - **testCase** (Object) - Optional - Definition of the testCase being executed - **testSuiteRun** (Object) - Optional - A testSuiteRun to associate this testCaseRun with a containing testSuiteRun - **trigger** (Object) - Optional - What triggered this testSuiteRun ``` -------------------------------- ### Artifact Packaged Event Source: https://cdevents.dev/docs/continuous-integration Represents an artifact that has been packaged for distribution and is now versioned. ```APIDOC ## `artifact packaged` ### Description The event represents an artifact that has been packaged for distribution; this artifact is now versioned with a fixed version. This event is usually produced by the build system. If an SBOM URI is available at this stage, it should be included. ### Event Type `dev.cdevents.artifact.packaged.0.3.0` ### Subject `artifact` ### Fields #### id - **Type**: `Purl` - **Description**: See id - **Required**: ✅ - **Examples**: `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` #### source - **Type**: `URI-Reference` - **Description**: See source - **Required**: #### change - **Type**: `object` - **Description**: The change (tag, commit, revision) of the repository which was used to build the artifact" - **Required**: ✅ - **Examples**: `{"id": "527d4a1aca5e8d0df24813df5ad65d049fc8d312", "source": "my-git.example/an-org/a-repo"}`, `{"id": "feature1234", "source": "my-git.example/an-org/a-repo"}` #### sbom - **Type**: `sbom` - **Description**: The Software Bill of Material (SBOM) associated with the artifact - **Required**: - **Examples**: `{"uri": "https://sbom.storage.service/my-projects/3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427.sbom"}` ``` -------------------------------- ### testCaseRun finished Source: https://cdevents.dev/docs/testing Represents a finished testCase execution with outcome metadata. ```APIDOC ## EVENT dev.cdevents.testcaserun.finished.0.3.0 ### Description This event represents a finished testCase execution, containing the outcome and additional metadata. ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - source from the context - **environment** (Object) - Required - The environment in which this testCaseRun was running - **testCase** (Object) - Optional - Definition of the testCase being executed - **testSuiteRun** (Object) - Optional - A testSuiteRun to associate this testCaseRun with a containing testSuiteRun - **outcome** (String) - Required - The outcome of the testSuite execution (success, failure, cancel, error) - **severity** (String) - Optional - Severity if the test failed - **reason** (String) - Optional - A reason related to the outcome ``` -------------------------------- ### testCaseRun skipped Source: https://cdevents.dev/docs/testing Represents a skipped testCaseRun execution. ```APIDOC ## EVENT dev.cdevents.testcaserun.skipped.0.2.0 ### Description This event represents a skipped testCaseRun execution, emitted if no prior queued or started event occurred. ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - source from the context - **environment** (Object) - Required - The environment in which this testCaseRun would have run - **testCase** (Object) - Optional - Definition of the testCase being executed - **testSuiteRun** (Object) - Optional - A testSuiteRun to associate this testCaseRun with a containing testSuiteRun - **severity** (String) - Optional - Severity if the test failed - **reason** (String) - Optional - A reason for skipping the test case run ``` -------------------------------- ### testSuiteRun queued Source: https://cdevents.dev/docs/testing Represents when a testSuiteRun has been queued for execution and is waiting for preconditions to be met. ```APIDOC ## EVENT dev.cdevents.testsuiterun.queued.0.3.0 ### Description This event represents when a testSuiteRun has been queued for execution - and is waiting for applicable preconditions to be met before actually executing. ### Parameters #### Request Body - **id** (String) - Required - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Optional - source from the context - **environment** (Object) - Required - The environment in which this testSuiteRun is queued - **testSuite** (Object) - Optional - Definition of the testSuite being executed - **trigger** (Object) - Optional - What triggered this testSuiteRun ``` -------------------------------- ### dev.cdevents.change.abandoned.0.3.0 Source: https://cdevents.dev/docs/source-code-version-control Event triggered when a change is considered abandoned due to inactivity. ```APIDOC ## dev.cdevents.change.abandoned.0.3.0 ### Description A tool or a user decides that the change has been inactive for a while and it can be considered abandoned. ### Parameters #### Request Body - **id** (String) - Required - See id - **source** (URI-Reference) - Optional - See source - **repository** (Object) - Optional - A reference to the repository where the change event happened ### Request Example { "id": "1234", "source": "my-git.example/an-org/a-repo", "repository": {"id": "an-org/a-repo"} } ``` -------------------------------- ### Repository Subject Source: https://cdevents.dev/docs/source-code-version-control Defines the structure and fields for a 'repository' subject in CDevents. ```APIDOC ## Repository Subject An SCM `repository` is identified by a `name`, an `owner` which can be a user or an organization, a `url` which is where the `repository` is hosted and optionally a `viewUrl`, which is a web location for humans to browse the content of the `repository`. ### Fields | Field | Type | Description | Examples | | ------- | ------------- | ------------------------------------------------------------------------ | -------------------------------------- | | id | `String` | See id | `an-org/a-repo`, `an-user/a-repo` | | source | `URI-Reference` | See source | `my-git.example` | | name | `String` | The name of the `repository` | `spec`, `community`, `a-repo` | | owner | `String` | The owner of the `repository` | `cdevents`, `an-org`, `an-user` | | url | `URI` | URL to the `repository` for API operations. This URL needs to include the protocol used to connect to the repository. | `git://my-git.example/an-org/a-repo` | | viewUrl | `URI` | URL for humans to view the content of the `repository` | `https://my-git.example/an-org/a-repo/view` | ``` -------------------------------- ### pipelineRun Subject Definition Source: https://cdevents.dev/docs/core Defines the structure and fields for a pipelineRun, representing an instance of a pipeline execution. ```APIDOC ## pipelineRun Subject ### Description A pipelineRun represents an instance of a pipeline, used to track build and release progress. ### Fields - **id** (String) - Unique identifier for the pipelineRun. - **source** (URI-Reference) - The source of the event. - **pipelineName** (String) - The name of the pipeline. - **outcome** (String) - Outcome of a finished pipelineRun (success, failure, cancel, error). - **url** (URI) - URL to the pipelineRun dashboard or API. - **errors** (String) - Details about the failure if applicable. ``` -------------------------------- ### CDEvents Required Context Attributes Source: https://cdevents.dev/docs/spec Details the mandatory fields (id, type, source) that must be present in every CDEvents message. ```APIDOC ## CDEvents Context Attributes ### Description Every CDEvents message must include specific context attributes to ensure proper identification, typing, and source tracking. ### Required Attributes - **id** (String) - Required - Unique identifier for the event. Must be unique within the scope of the producer. - **type** (String) - Required - Defines the event type using the format `dev.cdevents...`. Custom events use the `dev.cdeventsx.` prefix. - **source** (URI-Reference) - Required - Defines the context in which the event occurred, providing global uniqueness when combined with the event ID. ``` -------------------------------- ### SBOM Object Definition Source: https://cdevents.dev/docs/continuous-integration Defines the structure of the sbom object used in CDEvents to reference external SBOMs. ```APIDOC ## SBOM Object Several events reference a Software Bill of Materials (SBOM). In CDEvents SBOMs are represented via the `sbom` object, which is a reference to an externally hosted SBOM. The `sbom` object includes a single `uri` field, and is defined as an object to allow for more fields to be added in a backwards compatible manner in future. ### Fields - **uri** (`URI-Reference`) - Required - Link to an externally hosted SBOM. - Examples: `https://sbom.storage.service/my-projects/3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427.sbom` ``` -------------------------------- ### testOutput Subject Source: https://cdevents.dev/docs/testing Defines the schema for artifacts produced as a result of test execution. ```APIDOC ## testOutput ### Description Represents an output artifact produced by a testCaseRun, such as logs, reports, or videos. ### Fields - **id** (String) - Uniquely identifies the subject within the source. - **source** (URI-Reference) - Source from the context. - **outputType** (String) - The type of output (report, video, image, log, other). - **format** (String) - The Content-Type of the output artifact. - **uri** (URI-Reference) - A reference to retrieve the specified output artifact. - **testCaseRun** (Object) - An optional testCaseRun to link this artifact to a specific testCaseRun. ``` -------------------------------- ### dev.cdevents.ticket.created.0.2.0 Source: https://cdevents.dev/docs/tickets Event triggered when a new ticket is created in the ticketing system. ```APIDOC ## Event: dev.cdevents.ticket.created.0.2.0 ### Description This event represents a ticket that has been created within some ticketing system. ### Request Body - **id** (String) - Required - See id - **source** (URI-Reference) - Optional - See source - **summary** (String) - Required - The summary provided on the ticket - **ticketType** (Enum or String) - Optional - The ticket type - **creator** (String) - Required - The ticket author - **group** (String) - Optional - The group the ticket is currently assigned to - **assignees** (List (string)) - Optional - Who is currently investigating the ticket - **priority** (Enum or String) - Optional - An indicator of the importance of the ticket - **labels** (List (string)) - Optional - Labels associated to the ticket - **milestone** (String) - Optional - An ID that represents a goal for when this ticket is to be completed - **uri** (URI-Reference) - Required - A link to the ticket itself ``` -------------------------------- ### taskRun Subject Definition Source: https://cdevents.dev/docs/core Defines the structure and fields for a taskRun, representing an instance of a task within a pipeline or standalone. ```APIDOC ## taskRun Subject ### Description A taskRun represents an instance of a task, typically part of a pipeline execution. ### Fields - **id** (String) - Unique identifier for the taskRun. - **source** (URI-Reference) - The source of the event. - **taskName** (String) - The name of the task. - **pipelineRun** (Object) - The parent pipelineRun object containing the id. - **outcome** (String) - Outcome of a finished taskRun (success, failure, cancel, error). - **url** (URI) - URL to the taskRun dashboard or API. - **errors** (String) - Details about the failure if applicable. ``` -------------------------------- ### Incident Subject Source: https://cdevents.dev/docs/continuous-operations Defines the structure for an 'incident' event, representing a problem in a production environment. ```APIDOC ## Incident Subject ### Description An `incident` represents a problem in a production environment. To quote the definition of the term from the NIST glossary, an incident is: > An occurrence that actually or potentially jeopardizes the confidentiality, integrity, or availability of an information system or the information the system processes, stores, or transmits or that constitutes a violation or imminent threat of violation of security policies, security procedures, or acceptable use policies. ### Fields - **id** (String) - Unique identifier for the incident. Examples: `04896C75-F34D-40FF-A584-3F2B71CB9D47`, `issue123`, `risk-CVE123` - **source** (URI-Reference) - The source of the incident. Examples: `region1/production`, `monitoring-system/metricA` - **description** (String) - A short, free-style description of the incident. Examples: `Response time above 10ms`, `New CVE-123 detected` - **environment** (Object) - Reference to the environment where the incident occurred. Example: `{"id": "production"}`, `{"id": "staging"}`, `{"id": "prod123", "source": "iaas-region-1"}` - **service** (Object) - Reference to the service affected by the incident. Example: `{"id": "service123"}`, `{"id": "service123", "source": "region1/k8s/namespace"}` - **artifactId** (Purl) - Identifier of the artifact deployed with this service. Examples: `0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `927aa808433d17e315a258b98e2f1a55f8258e0cb782ccb76280646d0dbe17b5`, `six-1.14.0-py2.py3-none-any.whl` ``` -------------------------------- ### Repository Events Source: https://cdevents.dev/docs/source-code-version-control Events related to the modification or deletion of a source code repository. ```APIDOC ## dev.cdevents.repository.modified.0.3.0 ### Description A Source Code Repository modified some of its attributes, like location, or owner. ### Request Body - **id** (String) - Required - See id - **source** (URI-Reference) - Optional - See source - **name** (String) - Required - The name of the repository - **owner** (String) - Optional - The owner of the repository - **url** (URI) - Required - URL to the repository - **viewUrl** (URI) - Optional - URL for humans to view the content of the repository ## dev.cdevents.repository.deleted.0.3.0 ### Description Event triggered when a repository is deleted. ### Request Body - **id** (String) - Required - See id - **source** (URI-Reference) - Optional - See source - **name** (String) - Optional - The name of the repository - **owner** (String) - Optional - The owner of the repository - **url** (URI) - Optional - URL to the repository - **viewUrl** (URI) - Optional - URL for humans to view the content of the repository ``` -------------------------------- ### pipelineRun Finished Source: https://cdevents.dev/docs/core Event triggered when a pipelineRun has finished execution. ```APIDOC ## dev.cdevents.pipelinerun.finished.0.3.0 ### Description Indicates that a pipelineRun has finished, regardless of outcome. ### Parameters #### Request Body - **id** (String) - Required - Unique identifier for the pipelineRun - **source** (URI-Reference) - Optional - Source of the event - **pipelineName** (String) - Optional - Name of the pipeline - **url** (URI) - Optional - URL to the pipelineRun - **outcome** (String) - Required - Outcome: success, failure, cancel, or error - **errors** (String) - Optional - Details about failure or cancellation ```