Adding api references to each command and fixing docs-generation to match current docs (#111)

Author: wolfo951

src/commands/access-control/group/create.ts

@@ -10,10 +10,10 @@ import BaseCommand from "../../../extensions/base-command.js";
 import { CustomFlags } from "../../../extensions/custom-flags.js";
 
 export default class CreateAccessControlGroup extends BaseCommand {
-    static apiReference : apiReference = {
+    static apiReference: apiReference = {
         link: "https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-group/",
         name: "Create iTwin Group",
-    }
+    };
 
     static description = 'Create a new group for an iTwin.';
 

src/commands/access-control/group/delete.ts

@@ -5,10 +5,16 @@
 
 import { Flags } from "@oclif/core";
 
+import { apiReference } from "../../../extensions/api-reference.js";
 import BaseCommand from "../../../extensions/base-command.js";
 import { CustomFlags } from "../../../extensions/custom-flags.js";
 
 export default class DeleteAccessControlGroup extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-group/",
+        name: "Delete iTwin Group",
+    };
+
     static description = 'Delete an existing group from an iTwin.';
 
     static examples = [

src/commands/access-control/group/info.ts

@@ -5,10 +5,16 @@
 
 import { Flags } from "@oclif/core";
 
+import { apiReference } from "../../../extensions/api-reference.js";
 import BaseCommand from "../../../extensions/base-command.js";
 import { CustomFlags } from "../../../extensions/custom-flags.js";
 
 export default class AccessControlGroupInfo extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group/",
+        name: "Get iTwin Group Info",
+    };
+
     static description = 'Retrieve details about a specific group in an iTwin.';
 
     static examples = [

src/commands/access-control/group/list.ts

@@ -3,10 +3,16 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 
+import { apiReference } from "../../../extensions/api-reference.js";
 import BaseCommand from "../../../extensions/base-command.js";
 import { CustomFlags } from "../../../extensions/custom-flags.js";
 
 export default class ListAccessControlGroups extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-groups/",
+        name: "Get iTwin Groups",
+    };
+
     static description = 'List all groups for a specific iTwin.';
 
     static examples = [

src/commands/access-control/group/update.ts

@@ -5,10 +5,16 @@
 
 import { Flags } from "@oclif/core";
 
+import { apiReference } from "../../../extensions/api-reference.js";
 import BaseCommand from "../../../extensions/base-command.js";
 import { CustomFlags } from "../../../extensions/custom-flags.js";
 
 export default class UpdateAccessControlGroup extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group/",
+        name: "Update iTwin Group",
+    };
+
     static description = 'Update the details of an existing group in an iTwin.';
 
     static examples = [

src/commands/access-control/member/group/add.ts

@@ -5,16 +5,22 @@
 
 import { Flags } from "@oclif/core";
 
+import { apiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
 import { GroupMember } from "../../../../services/access-control-client/models/group.js";
 
 export default class AddGroupMembers extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-group-members/",
+        name: "Add iTwin Group Members",
+    };
+
     static description = 'Add one or more groups as members to an iTwin.';
 
     static examples = [
       {
-        command: `<%= config.bin %> <%= command.id %> --itwin-id "ad0ba809-9241-48ad-9eb0-c8038c1a1d51" --groups '[{"groupId": "group1-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]}, {"groupId": "group2-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]}]',`,
+        command: `<%= config.bin %> <%= command.id %> --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --groups '[{"groupId": "group1-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]}, {"groupId": "group2-id", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]}]',`,
         description: 'Example 1: Add one or more groups as members to an iTwin.'
       }
     ];

src/commands/access-control/member/group/delete.ts

@@ -5,10 +5,16 @@
 
 import { Flags } from "@oclif/core";
 
+import { apiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
 
 export default class DeleteGroupMember extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-group-member/",
+        name: "Remove iTwin Group Member",
+    };
+
     static description = 'Remove a group from an iTwin.';
 
     static examples = [
@@ -40,4 +46,3 @@ export default class DeleteGroupMember extends BaseCommand {
       return this.logAndReturnResult({ result: 'deleted' });
     }
   }
-  

src/commands/access-control/member/group/info.ts

@@ -5,10 +5,16 @@
 
 import { Flags } from "@oclif/core";
 
+import { apiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
 
 export default class InfoGroupMember extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-member/",
+        name: "Get iTwin Group Member",
+    };
+
     static description = 'Retrieve details about a specific group member in an iTwin.';
 
     static examples = [
@@ -40,4 +46,3 @@ export default class InfoGroupMember extends BaseCommand {
       return this.logAndReturnResult(result.member);
     }
   }
-  

src/commands/access-control/member/group/list.ts

@@ -3,10 +3,16 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 
+import { apiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
 
 export default class ListGroupMembers extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-members/",
+        name: "Get iTwin Group Members",
+    };
+
     static description = 'List all group members of an iTwin.';
 
     static examples = [
@@ -32,4 +38,3 @@ export default class ListGroupMembers extends BaseCommand {
       return this.logAndReturnResult(result.members);
     }
   }
-  

src/commands/access-control/member/group/update.ts

@@ -5,15 +5,21 @@
 
 import { Flags } from "@oclif/core";
 
+import { apiReference } from "../../../../extensions/api-reference.js";
 import BaseCommand from "../../../../extensions/base-command.js";
 import { CustomFlags } from "../../../../extensions/custom-flags.js";
 
 export default class UpdateGroupMember extends BaseCommand {
+    static apiReference: apiReference = {
+        link: "https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group-member/",
+        name: "Update iTwin Group Member",
+    };
+
     static description = 'Update the role assignments for a group in an iTwin.';
 
     static examples = [
       {
-        command: `<%= config.bin %> <%= command.id %> --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id group1-id --role-ids role1-id --role-ids role2-id`,
+        command: `<%= config.bin %> <%= command.id %> --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id group1-id --role-id role1-id --role-id role2-id`,
         description: 'Example 1:'
       }
     ];
@@ -46,4 +52,3 @@ export default class UpdateGroupMember extends BaseCommand {
       return this.logAndReturnResult(response.member);
     }
   }
-