Skip to content

Commit

Permalink
Consistent enum type in markdown docs (cdevents#158)
Browse files Browse the repository at this point in the history 
Consistent usage of String (enum) across the markdown documents where an enum type is used in the schema.

This is in relation to cdevents#157

---------

Signed-off-by: Owen Bower Adams <owen+github@obowersa.net>
Co-authored-by: Emil Bäckmark <emil.backmark@ericsson.com>
  • Loading branch information
@obowersa @e-backmark-ericsson
obowersa and e-backmark-ericsson authored Aug 25, 2023
1 parent d5fbf11 commit 6c4a279
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions core.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ track the build and release progress on a particular software artifact.
| source | `URI-Reference` | See [source](spec.md#source-subject) | |
| type | `String` | See [type](spec.md#type-subject) | `pipelineRun` |
| pipelineName | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` |
| outcome | `Enum` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`|
| outcome | `String` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`|
| url | `URI` | url to the `pipelineRun` | `https://dashboard.org/namespace/pipelinerun-1234`, `https://api.cdsystem.com/namespace/pipelinerun-1234` |
| errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `pipelineRun cancelled by user`, `Unit tests failed`|

Expand All @@ -56,7 +56,7 @@ associated, in which case it is acceptable to generate only taskRun events.
| type | `String` | See [type](spec.md#type-subject) | `taskRun` |
| taskName | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` |
| pipelineRun | `Object` ([`pipelineRun`](#pipelinerun)) | The `pipelineRun` that this `taskRun` belongs to. | `{"id": "namespace/pipelinerun-1234"}`|
| outcome | `Enum` | outcome of a finished `taskRun` | `success`, `error` or `failure`|
| outcome | `String` | outcome of a finished `taskRun` | `success`, `error` or `failure`|
| url | `URI` | url to the `taskRun` | `https://dashboard.org/namespace/taskrun-1234`, `https://api.cdsystem.com/namespace/taskrun-1234` |
| errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `taskRun cancelled by user`, `Unit tests failed`|

Expand Down Expand Up @@ -111,7 +111,7 @@ A pipelineRun has finished, successfully or not.
| type | `String` | See [type](spec.md#type-subject) | `pipelineRun` | |
| pipelineName | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` | |
| url | `URI` | url to the `pipelineRun` | `https://dashboard.org/namespace/pipelinerun-1234`, `https://api.cdsystem.com/namespace/pipelinerun-1234` | |
| outcome | `Enum` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`| |
| outcome | `String (enum)` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`| |
| errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `pipelineRun cancelled by user`, `Unit tests failed`| |

### [`taskRun Started`](examples/taskrun_started.json)
Expand Down Expand Up @@ -147,5 +147,5 @@ A taskRun has finished, successfully or not.
| taskName | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` | |
| pipelineRun | `Object` ([`pipelineRun`](#pipelinerun)) | The `pipelineRun` that this `taskRun` belongs to. | `{"id": "namespace/pipelinerun-1234"}`| |
| url | `URI` | url to the `taskRun` | `https://dashboard.org/namespace/taskrun-1234`, `https://api.cdsystem.com/namespace/taskrun-1234` | |
| outcome | `Enum` | outcome of a finished `taskRun` | `success`, `error` or `failure`| |
| outcome | `String (enum)` | outcome of a finished `taskRun` | `success`, `error` or `failure`| |
| errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `taskRun cancelled by user`, `Unit tests failed`| |
16 changes: 8 additions & 8 deletions testing-events.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ One or more `testOutput` artifacts are usually produced as the result of a test
|-------------|----------------------------------------|---------------------------------------------------------------------------|-----------------------------------------------------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `report-23123123` |
| source | `URI-Reference` | [source](spec.md#source--context-) from the context | `staging/testkube`, `testkube-dev-123` |
| outputType | `String` | The type of output, one of `report`, `video`, `image`, `log`, `other` | `video` |
| outputType | `String (enum)` | The type of output, one of `report`, `video`, `image`, `log`, `other` | `video` |
| format | `String` | The Content-Type of the output artifact | `application/pdf`, `image/png`, `application/json` |
| uri | `URI-Reference` | A reference to retrieve the specified output artifact | `https://testkube.mycluster.internal/artifacts/23123123` |
| testCaseRun | `Object` [`testCaseRun`](#testcaserun) | An optional testCaseRun to link this artifact to a specific `testCaseRun` | `{"id":"Login-Test-execution-1213423", "source": "staging/testkube"}` |
Expand Down Expand Up @@ -113,8 +113,8 @@ This event represents a finished testCase execution. The event will contain the
| environment | `Object` [`environment`](continuous-deployment.md/#environment) | The environment in which this testCaseRun was running | `{"id": "1234"}`, `{"id": "dev", "source": "testkube-dev-123"}` | ✅ |
| testCase | `Object` [`testCase`](#testcase) | Definition of the testCase being executed | `{"id": "92834723894", "name": "Login Test", "type": "integration"}` | |
| testSuiteRun | `Object` [`testSuiteRun`](#testsuiterun) | A testSuiteRun to associate this testCaseRun with a containing testSuiteRun | `{"id":"Auth-TestSuite-execution-12334", "source": "staging/testkube"}` | |
| outcome | `String` | The outcome of the testSuite execution, one of `pass`, `fail`, `cancel`, `error` | `pass` | ✅ |
| severity | `String` | Severity if the test failed, one of `low`, `medium`, `high`, `critical` | `critical` |
| outcome | `String (enum)` | The outcome of the testSuite execution, one of `pass`, `fail`, `cancel`, `error` | `pass` | ✅ |
| severity | `String (enum)` | Severity if the test failed, one of `low`, `medium`, `high`, `critical` | `critical` |
| reason | `String` | A reason related to the outcome of the execution | `Cancelled by user`, `Failed assertion`, `Timed out` | |

### [`testSuiteRun queued`](examples/testsuiterun_queued.json)
Expand Down Expand Up @@ -163,8 +163,8 @@ This event represents a finished testSuite execution. The event will contain the
| id | `String` | Uniquely identifies the subject within the source. | `unit`, `e2e`, `security` | ✅ |
| source | `URI-Reference` | [source](spec.md#source--context-) from the context | | |
| environment | `Object` [`environment`](continuous-deployment.md/#environment) | The environment in which this testSuiteRun was running | `{"id": "1234"}`, `{"id": "dev", "source": "testkube-dev-123"}` | ✅ |
| outcome | `String` | The outcome of the testSuite execution, one of `pass`, `fail`, `cancel`, `error` | `fail` | ✅ |
| severity | `String` | Severity if the test failed, one of `low`, `medium`, `high`, `critical` | `critical`, `low`, `medium`, `high` |
| outcome | `String (enum)` | The outcome of the testSuite execution, one of `pass`, `fail`, `cancel`, `error` | `fail` | ✅ |
| severity | `String (enum)` | Severity if the test failed, one of `low`, `medium`, `high`, `critical` | `critical`, `low`, `medium`, `high` |
| reason | `String` | A reason related to the outcome of the execution | `Cancelled by user`, `Failed testCase` | |
| testSuite | `Object` [`testSuite`](#testsuite) | Definition of the testSuite being executed | `{"id": "92834723894", "name": "Auth TestSuite"}` | |

Expand All @@ -180,7 +180,7 @@ The event represents a test execution output that has been published.
|-------------|----------------------------------------|---------------------------------------------------------------------------|-----------------------------------------------------------------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `12312334` | ✅ |
| source | `URI-Reference` | [source](spec.md#source--context-) from the context | | ✅ |
| outputType | `String` | The type of output, one of `report`, `video`, `image`, `log`, `other` | `video` | ✅ |
| outputType | `String (enum)` | The type of output, one of `report`, `video`, `image`, `log`, `other` | `video` | ✅ |
| format | `String` | The Content-Type of the output artifact | `application/pdf`, `image/png`, `application/json` | ✅ |
| uri | `URI-Reference` | A reference to retrieve the specified output artifact | `https://testkube.mycluster.internal/artifacts/23123123` | |
| testCaseRun | `Object` [`testCaseRun`](#testcaserun) | An optional testCaseRun to link this artifact to a specific `testCaseRun` | `{"id":"Login-Test-execution-1213423", "source": "staging/testkube"}` | |
Expand All @@ -193,7 +193,7 @@ A `trigger` in this context is what started a corresponding testCaseRun/testSuit

| Field | Type | Description | Examples | Required |
|-------|-----------------|--------------------------------------------------------------------------------|----------|----------|
| type | `String` | The type of trigger, one of `manual`, `pipeline`, `event`, `schedule`, `other` | | ✅ |
| type | `String (enum)` | The type of trigger, one of `manual`, `pipeline`, `event`, `schedule`, `other` | | ✅ |
| uri | `URI-Reference` | A uri reference to this trigger | | |

### `testCase`
Expand All @@ -203,7 +203,7 @@ A `testCase` is the actual test that is being run by a `testCaseRun`.
| Field | Type | Description | Examples | Required |
|---------|-----------------|-----------------------------------------------------------------------------------------------------------------------|----------------------------|----------|
| id | `String` | Uniquely identifies the testCase within a test management system. | `12312334` | ✅ |
| type | `String enum` | The type of test, one of `performance`, `functional`, `unit`, `security`, `compliance`, `integration`, `e2e`, `other` | `functional` | |
| type | `String (enum)` | The type of test, one of `performance`, `functional`, `unit`, `security`, `compliance`, `integration`, `e2e`, `other` | `functional` | |
| name | `String` | A user-friendly name for this testCase | `Login Test` | |
| version | `String` | The version of the testCase | `1.0` | |
| uri | `URI-Reference` | A uri reference to this testCase | | |
Expand Down

0 comments on commit 6c4a279

Please sign in to comment.