From 2d43e47610dfb71ae9b82fda36c5646cb389d79e Mon Sep 17 00:00:00 2001 From: Tim Perry Date: Fri, 13 Oct 2017 20:29:47 +0200 Subject: [PATCH] Add device api keys warning on device register and os configure --- build/actions/device.js | 2 +- build/actions/os.js | 2 +- doc/cli.markdown | 4 ++++ lib/actions/device.coffee | 2 ++ lib/actions/os.coffee | 2 ++ 5 files changed, 10 insertions(+), 2 deletions(-) diff --git a/build/actions/device.js b/build/actions/device.js index 29d9aab0..2ae14456 100644 --- a/build/actions/device.js +++ b/build/actions/device.js @@ -84,7 +84,7 @@ exports.supported = { exports.register = { signature: 'device register ', description: 'register a device', - help: 'Use this command to register a device to an application.\n\nExamples:\n\n $ resin device register MyApp\n $ resin device register MyApp --uuid \n $ resin device register MyApp --uuid --device-api-key ', + help: 'Use this command to register a device to an application.\n\nNote that device api keys are only supported on ResinOS 2.0.3+\n\nExamples:\n\n $ resin device register MyApp\n $ resin device register MyApp --uuid \n $ resin device register MyApp --uuid --device-api-key ', permission: 'user', options: [ { diff --git a/build/actions/os.js b/build/actions/os.js index 418f47f8..13198d99 100644 --- a/build/actions/os.js +++ b/build/actions/os.js @@ -190,7 +190,7 @@ exports.buildConfig = { exports.configure = { signature: 'os configure [deviceApiKey]', description: 'configure an os image', - help: 'Use this command to configure a previously downloaded operating system image for the specific device.\n\nExamples:\n\n $ resin os configure ../path/rpi.img 7cf02a6\n $ resin os configure ../path/rpi.img 7cf02a6 ', + help: 'Use this command to configure a previously downloaded operating system image for the specific device.\n\nNote that device api keys are only supported on ResinOS 2.0.3+\n\nExamples:\n\n $ resin os configure ../path/rpi.img 7cf02a6\n $ resin os configure ../path/rpi.img 7cf02a6 ', permission: 'user', options: [ commandOptions.advancedConfig, { diff --git a/doc/cli.markdown b/doc/cli.markdown index 65d6207c..d07eeb10 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -331,6 +331,8 @@ Examples: Use this command to register a device to an application. +Note that device api keys are only supported on ResinOS 2.0.3+ + Examples: $ resin device register MyApp @@ -908,6 +910,8 @@ the path to the output JSON file Use this command to configure a previously downloaded operating system image for the specific device. +Note that device api keys are only supported on ResinOS 2.0.3+ + Examples: $ resin os configure ../path/rpi.img 7cf02a6 diff --git a/lib/actions/device.coffee b/lib/actions/device.coffee index 6a6ab11b..30842740 100644 --- a/lib/actions/device.coffee +++ b/lib/actions/device.coffee @@ -131,6 +131,8 @@ exports.register = help: ''' Use this command to register a device to an application. + Note that device api keys are only supported on ResinOS 2.0.3+ + Examples: $ resin device register MyApp diff --git a/lib/actions/os.coffee b/lib/actions/os.coffee index 7dba0722..b055d965 100644 --- a/lib/actions/os.coffee +++ b/lib/actions/os.coffee @@ -201,6 +201,8 @@ exports.configure = help: ''' Use this command to configure a previously downloaded operating system image for the specific device. + Note that device api keys are only supported on ResinOS 2.0.3+ + Examples: $ resin os configure ../path/rpi.img 7cf02a6