Skip to content

Commit 246b339

Browse files
authored
Merge pull request #9 from currents-dev/fix/complete-type-formatting-cleanup
Complete type formatting cleanup in API parameter documentation
2 parents 18557cc + caf6183 commit 246b339

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

resources/api/api-resources/test-results.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -178,18 +178,18 @@ Learn how to generate [test-signature.md](test-signature.md "mention") before us
178178
| `spec` | `string` | Name of the spec file which the test belongs to. [spec-files.md](spec-files.md "mention") |
179179
| `machineId` | `string` | ID of the machine which executed the test. |
180180
| `signature` | `string` | Signature of the test [test-signature.md](test-signature.md "mention") |
181-
| `title` | `Array<String>` | Title of the test. [See test title](https://docs.currents.dev/resources/api/api-resources/test-signature#test-title). |
181+
| `title` | `string[]` | Title of the test. [See test title](https://docs.currents.dev/resources/api/api-resources/test-signature#test-title). |
182182
| `testId` | `string` | ID of the test as reporter by its framework. |
183-
| `expectedStatus` | `String<failed \| passed \| pending \| skipped>` | Spected status of the test. Only available for Playwright. |
184-
| `status` | `String<failed \| passed \| pending \| skipped>` | Final status of the test after the execution |
183+
| `expectedStatus` | `"failed" \| "passed" \| "pending" \| "skipped"` | Expected status of the test. Only available for Playwright. |
184+
| `status` | `"failed" \| "passed" \| "pending" \| "skipped"` | Final status of the test after the execution |
185185
| `framework` | `Framework` | Information about the framework and reporter used for the test execution [#framework](test-results.md#framework "mention") |
186186
| `displayError` | `string` | Latest error from the test execution |
187187
| `commit` | `Commit` | Git commit information [#commit](test-results.md#commit "mention") |
188-
| `createdAt` | `String (ISO Datetime)` | Date of the test execution |
188+
| `createdAt` | `string (ISO 8601)` | Date of the test execution |
189189
| `duration` | `number` | Total duration of the test execution in milliseconds |
190190
| `flaky` | `boolean` | Property that shows if the test is marked as flaky [flaky-tests.md](../../../dashboard/tests/flaky-tests.md "mention") |
191-
| `attempts` | `Array<Attempt>` | List of test execution attempts [#attempt](test-results.md#attempt "mention") |
192-
| `annotations` | `Array<Annotation>` | List of test annotations [#annotation](test-results.md#annotation "mention") |
191+
| `attempts` | `Attempt[]` | List of test execution attempts [#attempt](test-results.md#attempt "mention") |
192+
| `annotations` | `Annotation[]` | List of test annotations [#annotation](test-results.md#annotation "mention") |
193193

194194
#### Commit
195195

@@ -223,8 +223,8 @@ Learn how to generate [test-signature.md](test-signature.md "mention") before us
223223
| Name | Type | Description |
224224
| ----------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------- |
225225
| `attemptId` | `string` | ID of the attempt |
226-
| `state` | `Enum<failed \| passed \| pending \| skipped>` | Status of the attempt |
227-
| `startedAt` | `String (ISO Datetime)` | Start date of the attempt |
226+
| `state` | `"failed" \| "passed" \| "pending" \| "skipped"` | Status of the attempt |
227+
| `startedAt` | `string (ISO 8601)` | Start date of the attempt |
228228
| `duration` | `number` | Total duration of the attempt in milliseconds |
229229
| `error` | `Error` | Error object of the attempt in case of failure [#error](test-results.md#error "mention") |
230230

0 commit comments

Comments
 (0)