Skip to content

Commit

Permalink
deps: update raml2html
Browse files Browse the repository at this point in the history
  • Loading branch information
3v0k4 committed Jun 15, 2023
1 parent 7d5c956 commit 3137d5d
Show file tree
Hide file tree
Showing 15 changed files with 2,513 additions and 1,514 deletions.
8 changes: 4 additions & 4 deletions _api/v1/build_distributions/main.raml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
description: |
Endpoint expects a list of all test files in your test suite.
In response, you will get a list of test files that should be run on a node with particular __node_index__ value.
In response, you will get a list of test files that should be run on a node with particular **node_index** value.
You will get also __build_distribution_id__ (seed) to compare if all your CI nodes are running based on the same test suite split.
You will get also **build_distribution_id** (seed) to compare if all your CI nodes are running based on the same test suite split.
headers: !include ../headers/default.raml

body:
application/json:
schema: !include schema/subset/post.json
type: !include schema/subset/post.json

queryParameters:
fixed_test_suite_split: !include ../params/fixed_test_suite_split.raml
Expand All @@ -33,7 +33,7 @@
/last:
get:
description: |
This endpoint returns a list of test files recorded for CI build that closely matches given params like __commit_hash__, __branch__, __node_total__.
This endpoint returns a list of test files recorded for CI build that closely matches given params like **commit_hash**, **branch**, **node_total**.
If test files include paths to test cases then you need to merge them on your client-side to determine what test files are slow.
Expand Down
2 changes: 1 addition & 1 deletion _api/v1/build_subsets/main.raml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ post:

body:
application/json:
schema: !include schema/post.json
type: !include schema/post.json

queryParameters:
commit_hash: !include ../params/commit_hash.raml
Expand Down
14 changes: 7 additions & 7 deletions _api/v1/builds/main.raml
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
get:
description: |
Get list of all CI builds you have run. Array of CI builds is inside of __data__ key.
Get list of all CI builds you have run. Array of CI builds is inside of **data** key.
There are also available pagination urls in __links__ key so you can easily get CI builds for next page.
Key __meta__ contains basic info about current CI builds page.
There are also available pagination urls in **links** key so you can easily get CI builds for next page.
Key **meta** contains basic info about current CI builds page.
---
You can provide optional query params to filter list of CI builds by __commit_hash__, __branch__, __node_total__.
You can provide optional query params to filter list of CI builds by **commit_hash**, **branch**, **node_total**.
Example 1: /v1/builds?page=1&branch=master&node_total=2
Example 2: /v1/builds?page=1&commit_hash=d1acb81ac1bead703eb6de64d1af24104d5d4b2c
---
CI build means unique combination of __commit_hash__, __branch__, __node_total__.
CI build means unique combination of **commit_hash**, **branch**, **node_total**.
You can use __id__ of the build to fetch detailed info about tests recorded for that CI build by doing request to __/v1/builds/:id__ endpoint.
You can use **id** of the build to fetch detailed info about tests recorded for that CI build by doing request to **/v1/builds/:id** endpoint.
headers: !include ../headers/test_suite_token.raml

Expand All @@ -37,7 +37,7 @@ get:
description: |
Get detailed info about CI build with all build subsets containing the test files recorded timing for that CI build.
Note the CI build means unique combination of __commit_hash__, __branch__, __node_total__.
Note the CI build means unique combination of **commit_hash**, **branch**, **node_total**.
If you will run your tests multiple times for that combination then you will get multiple recorded build subset records with test files timing for particular CI node indexes.
headers: !include ../headers/test_suite_token.raml
Expand Down
6 changes: 3 additions & 3 deletions _api/v1/doc.raml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#%RAML 0.8
#%RAML 1.0
---
title: Knapsack Pro
baseUri: https://api.knapsackpro.com/{version}
title: Knapsack Pro API documentation
baseUri: https://api.knapsackpro.com/v1
version: v1
mediaType: application/json

Expand Down
2 changes: 1 addition & 1 deletion _api/v1/params/ci_build_id.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ example: 1234
description: |
It is a unique number for the CI build.
__ci_build_id__ can be integer or string.
**ci_build_id** can be integer or string.
2 changes: 1 addition & 1 deletion _api/v1/params/commit_hash.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ example: 6e3396177d9f8ca87e2b93b4b0a25babd09d574d
description: |
The most recent hash commit in your project.
You are running tests on the codebase with latest commit pointed to the __commit_hash__.
You are running tests on the codebase with latest commit pointed to the **commit_hash**.
2 changes: 1 addition & 1 deletion _api/v1/params/filters/node_total.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ example: 4
description: |
You can filter by total number of CI nodes you have run CI build on.
For instance if you parallelized your test suite across 4 machines then __node_total__ is 4.
For instance if you parallelized your test suite across 4 machines then **node_total** is 4.
2 changes: 1 addition & 1 deletion _api/v1/params/node_build_id.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ example: 1234
description: |
It is the unique number of the build on CI server.
__node_build_id__ can be integer or string.
**node_build_id** can be integer or string.
2 changes: 1 addition & 1 deletion _api/v1/params/node_index.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ example: 0
description: |
Index of current CI node where part of the test suite where executed.
__node_index__ starts from 0 so in case when __node_total__ is 4 then max __node_index__ is 3.
**node_index** starts from 0 so in case when **node_total** is 4 then max **node_index** is 3.
2 changes: 1 addition & 1 deletion _api/v1/params/node_total.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ example: 4
description: |
Total number of CI nodes you have.
For instance if you want to parallelize your test suite across 4 servers then __node_total__ is 4.
For instance if you want to parallelize your test suite across 4 servers then **node_total** is 4.
2 changes: 1 addition & 1 deletion _api/v1/params/test_files.raml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ example: |
description: |
JSON array with objects. Each object contains test file path and execution time for the test file.
Example contains only part of the test suite. The part of tests was executed on the CI node for specified __node_index__.
Example contains only part of the test suite. The part of tests was executed on the CI node for specified **node_index**.
8 changes: 4 additions & 4 deletions _api/v1/queues/main.raml
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
description: |
Endpoint expects a list of all test files in your test suite.
In response, you will get a list of test files that should be run on a node with particular __node_index__ value. The CI node can request this endpoint multiple times til it gets an empty list of test files which means the end of the queue.
In response, you will get a list of test files that should be run on a node with particular **node_index** value. The CI node can request this endpoint multiple times til it gets an empty list of test files which means the end of the queue.
You will get also __queue_name__ to compare if all your CI nodes are running against the same test suite queue created for particular CI build.
You will get also **queue_name** to compare if all your CI nodes are running against the same test suite queue created for particular CI build.
In response you will see __build_subset_id__ when you have `fixed_queue_split=true` in request. When __build_subset_id__ has a value then the test suite split was done based on this old recorded build subset. In that case the __queue_name__ will be null.
In response you will see **build_subset_id** when you have `fixed_queue_split=true` in request. When **build_subset_id** has a value then the test suite split was done based on this old recorded build subset. In that case the **queue_name** will be null.
headers: !include ../headers/default.raml

body:
application/json:
schema: !include schema/queue/post.json
type: !include schema/queue/post.json

queryParameters:
can_initialize_queue: !include ../params/can_initialize_queue.raml
Expand Down
Loading

0 comments on commit 3137d5d

Please sign in to comment.