fix: Add annotations to documentation

screwdriver-cd · Jun 14, 2017 · 90c3433 · 90c3433
1 parent 453feb7
commit 90c3433
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -29,9 +29,10 @@ npm install screwdriver-executor-base
 | Parameter        | Type  |  Description |
 | :-------------   | :---- | :-------------|
 | config        | Object | Configuration Object |
+| config.annotations | Object | Optional key/value object |
+| config.apiUri | String | Screwdriver's API |
 | config.buildId | String | The unique ID for a build |
 | config.container | String | Container for the build to run in |
-| config.apiUri | String | Screwdriver's API |
 | config.token | String | JWT to act on behalf of the build |
 
 ##### Expected Outcome

diff --git a/index.js b/index.js
@@ -37,9 +37,10 @@ class Executor {
      * Start a new build
      * @method start
      * @param {Object} config               Configuration
+     * @param {Object} [config.annotations] Optional key/value object
+     * @param {String} config.apiUri        Screwdriver's API
      * @param {String} config.buildId       Unique ID for a build
      * @param {String} config.container     Container for the build to run in
-     * @param {String} config.apiUri        Screwdriver's API
      * @param {String} config.token         JWT to act on behalf of the build
      * @return {Promise}
      */