Skip to content

Commit 90c3433

Browse files
committed
fix: Add annotations to documentation
1 parent 453feb7 commit 90c3433

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ npm install screwdriver-executor-base
2929
| Parameter | Type | Description |
3030
| :------------- | :---- | :-------------|
3131
| config | Object | Configuration Object |
32+
| config.annotations | Object | Optional key/value object |
33+
| config.apiUri | String | Screwdriver's API |
3234
| config.buildId | String | The unique ID for a build |
3335
| config.container | String | Container for the build to run in |
34-
| config.apiUri | String | Screwdriver's API |
3536
| config.token | String | JWT to act on behalf of the build |
3637

3738
##### Expected Outcome

index.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@ class Executor {
3737
* Start a new build
3838
* @method start
3939
* @param {Object} config Configuration
40+
* @param {Object} [config.annotations] Optional key/value object
41+
* @param {String} config.apiUri Screwdriver's API
4042
* @param {String} config.buildId Unique ID for a build
4143
* @param {String} config.container Container for the build to run in
42-
* @param {String} config.apiUri Screwdriver's API
4344
* @param {String} config.token JWT to act on behalf of the build
4445
* @return {Promise}
4546
*/

0 commit comments

Comments
 (0)