Saas 3234 openapi scope (#351)

* add scopes to token creation

* token patch command

* update description

* bump version

* move scopes display to formatter

* allow empty scopes

* any scope message

* update docs

Author: yaroslav-codefresh

lib/interface/cli/commands/tokens/apply.cmd.js

@@ -0,0 +1,50 @@
+const _ = require('lodash');
+const Command = require('../../Command');
+const applyCmd = require('../root/apply.cmd');
+const CFError = require('cf-errors');
+const { sdk } = require('../../../../logic');
+
+
+const command = new Command({
+    command: 'tokens <id>',
+    aliases: ['token'],
+    parent: applyCmd,
+    description: 'Patch Codefresh token',
+    usage: 'Update token name or scopes using token id. Id can be retrieved using "get" command',
+    webDocs: {
+        category: 'Tokens',
+        title: 'Patch token',
+        weight: 40,
+    },
+    builder: (yargs) => {
+        yargs
+            .positional('id', {
+                describe: 'token id',
+                required: true,
+            })
+            .option('name', {
+                describe: 'token name or ids',
+            })
+            .option('scope', {
+                alias: 's',
+                describe: 'token names or ids',
+                array: true,
+            })
+            .example('codefresh patch token [token_id] --name new-name', 'Update token name')
+            .example(
+                'codefresh patch token [token_id] -s pipeline -s project',
+                'Set token scopes to ["pipeline", "project"] (will replace old scopes with new)',
+            );
+    },
+    handler: async (argv) => {
+        if (argv.scope && _.isEmpty(argv.scope)) {
+            throw new CFError('Token must have at least one scope');
+        }
+        const { id, name, scope } = argv;
+        await sdk.tokens.patch({ id }, { name, scopes: scope });
+        console.log(`Token ${id} updated`);
+    },
+});
+
+module.exports = command;
+

lib/interface/cli/commands/tokens/create.cmd.js

@@ -25,6 +25,12 @@ const command = new Command({
                 choices: ['runtime-environment', 'user'],
                 default: 'user',
             })
+            .option('scope', {
+                alias: 's',
+                describe: 'user scopes',
+                array: true,
+                default: [],
+            })
             .positional('name', {
                 describe: 'token name',
                 required: true,
@@ -49,6 +55,7 @@ const command = new Command({
             subjectReference: argv.subject,
         }, {
             name: argv.name,
+            scopes: argv.scope,
         });
 
         console.log('Token created:');

lib/logic/entities/Token.js

@@ -6,14 +6,15 @@ class Token extends Entity {
         super();
         this.entityType = 'token';
         this.info = data;
-        this.defaultColumns = ['id', 'name', 'token_prefix', 'created'];
-        this.wideColumns = ['id', 'name', 'token_prefix', 'created', 'subject_type', 'subject'];
+        this.defaultColumns = ['id', 'name', 'token_prefix', 'created', 'scopes'];
+        this.wideColumns = ['id', 'name', 'token_prefix', 'created', 'subject_type', 'subject', 'scopes'];
     }
 
     static fromResponse(response) {
         const data = Object.assign({}, response);
         data.id = data._id;
         data.token_prefix = response.tokenPrefix;
+        data.scopes = _.isArray(response.scopes) ? response.scopes : ['any'];
         data.created = data.created ? new Date(data.created) : undefined;
         data.subject_type = _.get(data, 'subject.type');
         data.subject = _.get(data, 'subject.ref');

lib/output/formatters/Token.formatter.js

@@ -1,9 +1,11 @@
+const _ = require('lodash');
 const { Formatter, Style } = require('../Formatter');
 
 
 const FORMATTER = Formatter.build()
     .style('token_prefix', val => `${val}**************`)
     .style('created', Style.date)
+    .style('scopes', data => (_.isArray(data) && data.join('\n')) || data)
     .style('name', Style.cyan);
 
 module.exports = FORMATTER;

openapi.json

@@ -1854,6 +1854,38 @@
         ],
         "summary": "Delete",
         "x-sdk-interface": "tokens.delete"
+      },
+      "patch": {
+        "responses": {
+          "200": {
+            "description": "ok"
+          }
+        },
+        "tags": [
+          "tokens"
+        ],
+        "operationId": "tokens-patch",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "summary": "Patch",
+        "x-sdk-interface": "tokens.patch",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        }
       }
     },
     "/auth/keys": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.28.1",
+  "version": "0.29.0",
   "description": "Codefresh command line utility",
   "main": "index.js",
   "preferGlobal": true,