diff --git a/docs/access-control/group/create.md b/docs/access-control/group/create.md index 18948053..789bfdf8 100644 --- a/docs/access-control/group/create.md +++ b/docs/access-control/group/create.md @@ -4,6 +4,10 @@ Create a new group for an iTwin. ## Options +- **`-d, --description`** + A description of the group. + **Type:** `string` **Required:** Yes + - **`-i, --itwin-id`** The ID of the iTwin where the group is being created. **Type:** `string` **Required:** Yes @@ -12,10 +16,6 @@ Create a new group for an iTwin. The name of the group to be created. **Type:** `string` **Required:** Yes -- **`-d, --description`** - A description of the group. - **Type:** `string` **Required:** Yes - ## Examples ```bash @@ -24,4 +24,4 @@ itp access-control group create --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 ## API Reference -[Create iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-group/) +[Create iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-group/) \ No newline at end of file diff --git a/docs/access-control/group/delete.md b/docs/access-control/group/delete.md index 8b6a4793..3b2bbcc3 100644 --- a/docs/access-control/group/delete.md +++ b/docs/access-control/group/delete.md @@ -4,14 +4,14 @@ Delete an existing group from an iTwin. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin where the group exists. - **Type:** `string` **Required:** Yes - - **`-g, --group-id`** The ID of the group to be deleted. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin where the group exists. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp access-control group delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 ## API Reference -[Delete iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-group/) +[Delete iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-group/) \ No newline at end of file diff --git a/docs/access-control/group/info.md b/docs/access-control/group/info.md index 19ed9006..bfa01575 100644 --- a/docs/access-control/group/info.md +++ b/docs/access-control/group/info.md @@ -4,14 +4,14 @@ Retrieve details about a specific group in an iTwin. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin where the group exists. - **Type:** `string` **Required:** Yes - - **`-g, --group-id`** The ID of the group to retrieve information about. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin where the group exists. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp access-control group info --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 -- ## API Reference -[Get iTwin Group Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group/) +[Get iTwin Group Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group/) \ No newline at end of file diff --git a/docs/access-control/group/list.md b/docs/access-control/group/list.md index 23d131dc..ed7c6ad8 100644 --- a/docs/access-control/group/list.md +++ b/docs/access-control/group/list.md @@ -16,4 +16,4 @@ itp access-control group list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 ## API Reference -[Get iTwin Groups](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-groups/) +[Get iTwin Groups](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-groups/) \ No newline at end of file diff --git a/docs/access-control/group/update.md b/docs/access-control/group/update.md index c32c1d13..4bfa88fb 100644 --- a/docs/access-control/group/update.md +++ b/docs/access-control/group/update.md @@ -4,29 +4,29 @@ Update the details of an existing group in an iTwin. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin where the group exists. - **Type:** `string` **Required:** Yes - - **`-g, --group-id`** The ID of the group to be updated. **Type:** `string` **Required:** Yes -- **`-n, --name`** - The updated name of the group. - **Type:** `string` **Required:** No +- **`-i, --itwin-id`** + The ID of the iTwin where the group exists. + **Type:** `string` **Required:** Yes - **`-d, --description`** The updated description of the group. **Type:** `string` **Required:** No +- **`--ims-group`** + A list of IMS Groups to be linked to the group. + **Type:** `string` **Required:** No **Multiple:** Yes + - **`--member`** A list of members (emails) to be assigned to the group. - **Type:** `array of strings` **Required:** No **Multiple:** Yes + **Type:** `string` **Required:** No **Multiple:** Yes -- **`--ims-group`** - A list of IMS Groups to be linked to the group. - **Type:** `array of strings` **Required:** No **Multiple:** Yes +- **`-n, --name`** + The updated name of the group. + **Type:** `string` **Required:** No ## Examples @@ -35,9 +35,9 @@ Update the details of an existing group in an iTwin. itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --name "Updated Engineering Team" --description "Updated description" # Example 2: Update group members and IMS groups -itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --member john.doe@example.com --member jane.doe@example.com --ims-groups "Sample IMS Group" --ims-group "Sample IMS Group" +itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --member john.doe@example.com --member jane.doe@example.com --ims-group "Sample IMS Group" --ims-group "Sample IMS Group" ``` ## API Reference -[Update iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group/) +[Update iTwin Group](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group/) \ No newline at end of file diff --git a/docs/access-control/member/group/add.md b/docs/access-control/member/group/add.md index 9c9d9250..4d9c6a6d 100644 --- a/docs/access-control/member/group/add.md +++ b/docs/access-control/member/group/add.md @@ -4,23 +4,21 @@ Add one or more groups as members to an iTwin. ## Options +- **`--groups`** + A list of groups to add, each with a groupId and roleIds. + **Type:** `string` **Required:** Yes + - **`-i, --itwin-id`** The ID of the iTwin to which the groups will be added. **Type:** `string` **Required:** Yes -- **`--groups`** - A list of groups to add, each with a groupId and roleIds. - **Type:** `array` **Required:** Yes - ## Examples ```bash -itp access-control member group add --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"]} -]' +# Example 1: Add one or more groups as members to an iTwin. +itp access-control member group add --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"]}]', ``` ## API Reference -[Add iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-group-members/) +[Add iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-group-members/) \ No newline at end of file diff --git a/docs/access-control/member/group/delete.md b/docs/access-control/member/group/delete.md index 3f54b14b..6bc9419a 100644 --- a/docs/access-control/member/group/delete.md +++ b/docs/access-control/member/group/delete.md @@ -4,14 +4,14 @@ Remove a group from an iTwin. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin where the group is a member. - **Type:** `string` **Required:** Yes - - **`-g, --group-id`** The ID of the group to remove from the iTwin. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin where the group is a member. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp access-control member group delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c ## API Reference -[Remove iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-group-member/) +[Remove iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-group-member/) \ No newline at end of file diff --git a/docs/access-control/member/group/info.md b/docs/access-control/member/group/info.md index 2846e2aa..f8052753 100644 --- a/docs/access-control/member/group/info.md +++ b/docs/access-control/member/group/info.md @@ -4,14 +4,14 @@ Retrieve details about a specific group member in an iTwin. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin where the group is a member. - **Type:** `string` **Required:** Yes - - **`-g, --group-id`** The ID of the group to retrieve information about. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin where the group is a member. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp access-control member group info --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a ## API Reference -[Get iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-member/) +[Get iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-member/) \ No newline at end of file diff --git a/docs/access-control/member/group/list.md b/docs/access-control/member/group/list.md index fff2a65c..9caf5c2a 100644 --- a/docs/access-control/member/group/list.md +++ b/docs/access-control/member/group/list.md @@ -16,4 +16,4 @@ itp access-control member group list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a ## API Reference -[Get iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-members/) +[Get iTwin Group Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-group-members/) \ No newline at end of file diff --git a/docs/access-control/member/group/update.md b/docs/access-control/member/group/update.md index 74b9fb5b..88097107 100644 --- a/docs/access-control/member/group/update.md +++ b/docs/access-control/member/group/update.md @@ -4,17 +4,17 @@ Update the role assignments for a group in an iTwin. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin where the group is a member. - **Type:** `string` **Required:** Yes - - **`-g, --group-id`** The ID of the group whose roles will be updated. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin to which the groups will be added. + **Type:** `string` **Required:** Yes + - **`--role-id`** A list of role IDs to assign to the group. - **Type:** `array` **Required:** Yes **Multiple:** Yes + **Type:** `string` **Required:** Yes **Multiple:** Yes ## Examples @@ -24,4 +24,4 @@ itp access-control member group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c ## API Reference -[Update iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group-member/) +[Update iTwin Group Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-group-member/) \ No newline at end of file diff --git a/docs/access-control/member/invitations.md b/docs/access-control/member/invitations.md index ecf3aceb..f5c12bbd 100644 --- a/docs/access-control/member/invitations.md +++ b/docs/access-control/member/invitations.md @@ -16,4 +16,4 @@ itp access-control member invitations --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1 ## API Reference -[Get iTwin Member Invitations](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-member-invitations/) +[Get iTwin Member Invitations](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-member-invitations/) \ No newline at end of file diff --git a/docs/access-control/member/owner/add.md b/docs/access-control/member/owner/add.md index 0ae8ab10..f60f5d7d 100644 --- a/docs/access-control/member/owner/add.md +++ b/docs/access-control/member/owner/add.md @@ -4,14 +4,14 @@ Add a new owner to an iTwin by email. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin to which the owner will be added. - **Type:** `string` **Required:** Yes - - **`--email`** The email address of the new owner. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin to which the owner will be added. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp access-control member owner add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1 ## API Reference -[Add iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-owner-member/) +[Add iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-owner-member/) \ No newline at end of file diff --git a/docs/access-control/member/owner/delete.md b/docs/access-control/member/owner/delete.md index 5c09696f..d790733e 100644 --- a/docs/access-control/member/owner/delete.md +++ b/docs/access-control/member/owner/delete.md @@ -20,4 +20,4 @@ itp access-control member owner delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c ## API Reference -[Remove iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-owner-member/) +[Remove iTwin Owner](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-owner-member/) \ No newline at end of file diff --git a/docs/access-control/member/owner/list.md b/docs/access-control/member/owner/list.md index 8c8ae809..9ad3e015 100644 --- a/docs/access-control/member/owner/list.md +++ b/docs/access-control/member/owner/list.md @@ -16,4 +16,4 @@ itp access-control member owner list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a ## API Reference -[Get iTwin Owner Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-owner-members/) +[Get iTwin Owner Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-owner-members/) \ No newline at end of file diff --git a/docs/access-control/member/user/add.md b/docs/access-control/member/user/add.md index 269b0bcc..1bf10563 100644 --- a/docs/access-control/member/user/add.md +++ b/docs/access-control/member/user/add.md @@ -10,18 +10,15 @@ Add one or more user members to an iTwin. - **`--members`** A list of members to add, each with an email and a list of role IDs. - **Type:** `array` **Required:** Yes + **Type:** `string` **Required:** Yes ## Examples ```bash -# Example: Add multiple users to an iTwin with role IDs -itp access-control member user add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --members '[ - {"email": "john.johnson@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]}, - {"email": "maria.miller@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]} -]' +# Example 1: Add multiple users to an iTwin with role IDs +itp access-control member user add --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --members '[{"email": "user1@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]}, {"email": "user2@example.com", "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1"]}]' ``` ## API Reference -[Add iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-user-members/) +[Add iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/add-itwin-user-members/) \ No newline at end of file diff --git a/docs/access-control/member/user/delete.md b/docs/access-control/member/user/delete.md index 86e2d171..d4f102c6 100644 --- a/docs/access-control/member/user/delete.md +++ b/docs/access-control/member/user/delete.md @@ -20,4 +20,4 @@ itp access-control member user delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1 ## API Reference -[Remove iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-user-member/) +[Remove iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/remove-itwin-user-member/) \ No newline at end of file diff --git a/docs/access-control/member/user/info.md b/docs/access-control/member/user/info.md index 5dcb78a9..1e52c264 100644 --- a/docs/access-control/member/user/info.md +++ b/docs/access-control/member/user/info.md @@ -20,4 +20,4 @@ itp access-control member user info --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1 ## API Reference -[Get iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-member/) +[Get iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-member/) \ No newline at end of file diff --git a/docs/access-control/member/user/list.md b/docs/access-control/member/user/list.md index d11b18f7..b11c1668 100644 --- a/docs/access-control/member/user/list.md +++ b/docs/access-control/member/user/list.md @@ -16,4 +16,4 @@ itp access-control member user list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1 ## API Reference -[Get iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-members/) +[Get iTwin User Members](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-user-members/) \ No newline at end of file diff --git a/docs/access-control/member/user/update.md b/docs/access-control/member/user/update.md index ee59dc98..671e82d2 100644 --- a/docs/access-control/member/user/update.md +++ b/docs/access-control/member/user/update.md @@ -14,7 +14,7 @@ Update the role assignments for a user in an iTwin. - **`--role-id`** A list of role IDs to assign to the user. - **Type:** `array` **Required:** Yes **Multiple:** Yes + **Type:** `string` **Required:** Yes **Multiple:** Yes ## Examples @@ -24,4 +24,4 @@ itp access-control member user update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1 ## API Reference -[Update iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-user-member/) +[Update iTwin User Member](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-user-member/) \ No newline at end of file diff --git a/docs/access-control/permissions/all.md b/docs/access-control/permissions/all.md index 6f72c8a6..e46dc5b2 100644 --- a/docs/access-control/permissions/all.md +++ b/docs/access-control/permissions/all.md @@ -4,7 +4,7 @@ Retrieve a list of all iTwin Platform permissions. ## Options -(No options required for this command) +(This command does not have any options) ## Examples @@ -14,4 +14,4 @@ itp access-control permissions all ## API Reference -[Get All Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-all-permissions/) +[Get All Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-all-permissions/) \ No newline at end of file diff --git a/docs/access-control/permissions/me.md b/docs/access-control/permissions/me.md index eb534b67..cdcb8eeb 100644 --- a/docs/access-control/permissions/me.md +++ b/docs/access-control/permissions/me.md @@ -16,4 +16,4 @@ itp access-control permissions me --itwin-id e9a0d55a-65aa-42bd-9aa3-fd1c68d5e7b ## API Reference -[Get My iTwin Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-iTwin-permissions/) +[Get My iTwin Permissions](https://developer.bentley.com/apis/access-control-v2/operations/get-iTwin-permissions/) \ No newline at end of file diff --git a/docs/access-control/role/create.md b/docs/access-control/role/create.md index 78cfdcbc..2ff75080 100644 --- a/docs/access-control/role/create.md +++ b/docs/access-control/role/create.md @@ -4,6 +4,10 @@ Create a new role for an iTwin. To assign permissions after creation, use `itp a ## Options +- **`-d, --description`** + A description of the role. + **Type:** `string` **Required:** Yes + - **`-i, --itwin-id`** The ID of the iTwin for which the role is being created. **Type:** `string` **Required:** Yes @@ -12,10 +16,6 @@ Create a new role for an iTwin. To assign permissions after creation, use `itp a The name of the role to be created. **Type:** `string` **Required:** Yes -- **`-d, --description`** - A description of the role. - **Type:** `string` **Required:** Yes - ## Examples ```bash @@ -24,4 +24,4 @@ itp access-control role create --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 - ## API Reference -[Create iTwin Role](https://developer.bentley.com/apis/access-control-v2/operations/create-iTwin-role/) +[Create iTwin Role](https://developer.bentley.com/apis/access-control-v2/operations/create-iTwin-role/) \ No newline at end of file diff --git a/docs/access-control/role/delete.md b/docs/access-control/role/delete.md index 6bf4a738..0bdef832 100644 --- a/docs/access-control/role/delete.md +++ b/docs/access-control/role/delete.md @@ -20,4 +20,4 @@ itp access-control role delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 - ## API Reference -[Delete iTwin Role](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-role/) +[Delete iTwin Role](https://developer.bentley.com/apis/access-control-v2/operations/delete-itwin-role/) \ No newline at end of file diff --git a/docs/access-control/role/info.md b/docs/access-control/role/info.md index 0ef23b2a..bf81d998 100644 --- a/docs/access-control/role/info.md +++ b/docs/access-control/role/info.md @@ -20,4 +20,4 @@ itp access-control role info --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --r ## API Reference -[Get iTwin Role Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-role/) +[Get iTwin Role Info](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-role/) \ No newline at end of file diff --git a/docs/access-control/role/list.md b/docs/access-control/role/list.md index 900af246..c987f630 100644 --- a/docs/access-control/role/list.md +++ b/docs/access-control/role/list.md @@ -16,4 +16,4 @@ itp access-control role list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 ## API Reference -[Get iTwin Roles](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-roles/) +[Get iTwin Roles](https://developer.bentley.com/apis/access-control-v2/operations/get-itwin-roles/) \ No newline at end of file diff --git a/docs/access-control/role/update.md b/docs/access-control/role/update.md index a962b689..223a8de1 100644 --- a/docs/access-control/role/update.md +++ b/docs/access-control/role/update.md @@ -12,17 +12,17 @@ Update the details of an existing role in an iTwin. The ID of the role to be updated. **Type:** `string` **Required:** Yes -- **`-n, --name`** - The updated name of the role. - **Type:** `string` **Required:** No - - **`-d, --description`** The updated description of the role. **Type:** `string` **Required:** No +- **`-n, --name`** + The updated name of the role. + **Type:** `string` **Required:** No + - **`--permission`** A list of permissions to assign to the role. - **Type:** `array` **Required:** No **Multiple:** Yes + **Type:** `string` **Required:** No **Multiple:** Yes ## Examples @@ -36,4 +36,4 @@ itp access-control role update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 - ## API Reference -[Update iTwin Role](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-role/) +[Update iTwin Role](https://developer.bentley.com/apis/access-control-v2/operations/update-itwin-role/) \ No newline at end of file diff --git a/docs/api.md b/docs/api.md index b68b1c0c..dbe4a638 100644 --- a/docs/api.md +++ b/docs/api.md @@ -4,6 +4,15 @@ Make direct HTTP requests to any iTwin Platform API endpoint. Useful for custom ## Options +- **`--method`** + HTTP method for the request. + **Type:** `string` **Required:** Yes + **Valid Values:** `"GET"`, `"POST"`, `"PUT"`, `"DELETE"`, `"PATCH"` + +- **`--path`** + API endpoint path to send the request to. + **Type:** `string` **Required:** Yes + - **`--body`** The body to include in the request. It must be serialized JSON. **Type:** `string` **Required:** No @@ -16,15 +25,6 @@ Make direct HTTP requests to any iTwin Platform API endpoint. Useful for custom Headers to include in the request. Use the format 'HeaderName: value'. **Type:** `string` **Required:** No **Multiple:** Yes -- **`--method`** - HTTP method for the request. - **Type:** `string` **Required:** Yes - **Valid Values:** `"GET"`, `"POST"`, `"PUT"`, `"DELETE"`, `"PATCH"` - -- **`--path`** - API endpoint path to send the request to. - **Type:** `string` **Required:** Yes - - **`--query`** URL query parameters for the request. Use format 'QueryKey:value'. **Type:** `string` **Required:** No **Multiple:** Yes @@ -50,9 +50,8 @@ itp api --method POST --path itwins/exports --body '{"outputFormat": "JsonGZip"} # Example 5: Sending a post request (Windows PowerShell) itp api --method POST --path users/getbyidlist --body "[\`"b644de17-f07e-4b43-8c33-ad2b1bacee3b\`"]" - ``` ## APIs Docs Reference -[ITwin Platform APIs docs](https://developer.bentley.com/apis/) +[ITwin Platform APIs docs](https://developer.bentley.com/apis/) \ No newline at end of file diff --git a/docs/auth/info.md b/docs/auth/info.md index d3a1436f..5f034d63 100644 --- a/docs/auth/info.md +++ b/docs/auth/info.md @@ -2,6 +2,12 @@ Display authentication information. This command access current authentication storage and returns cached information about the current auth profile. +## Options + +(This command does not have any options) + +## Examples + ```bash itp auth info -``` +``` \ No newline at end of file diff --git a/docs/auth/logout.md b/docs/auth/logout.md index 1aa08a49..d222be38 100644 --- a/docs/auth/logout.md +++ b/docs/auth/logout.md @@ -2,6 +2,12 @@ Log out of the Bentley authentication session. This command clears the current authentication tokens and configuration. +## Options + +(This command does not have any options) + +## Examples + ```bash itp auth logout -``` +``` \ No newline at end of file diff --git a/docs/changed-elements/changesets.md b/docs/changed-elements/changesets.md index bfa97d9c..029139a8 100644 --- a/docs/changed-elements/changesets.md +++ b/docs/changed-elements/changesets.md @@ -4,22 +4,22 @@ Get the processing status of changesets in an iModel to see which are ready for ## Options -- **`-i, --itwin-id`** - The ID of the iTwin. - **Type:** `string` **Required:** Yes - - **`-m, --imodel-id`** The ID of the iModel. **Type:** `string` **Required:** Yes -- **`--top`** - Limit the number of changesets returned. - **Type:** `integer` **Required:** No +- **`-i, --itwin-id`** + The ID of the iTwin. + **Type:** `string` **Required:** Yes - **`--skip`** Skip a number of changesets in the result. **Type:** `integer` **Required:** No +- **`--top`** + Limit the number of changesets returned. + **Type:** `integer` **Required:** No + ## Examples ```bash @@ -35,4 +35,4 @@ itp changed-elements changesets --itwin-id 1a2b3c4d-5678-90ab-cdef-1234567890ab ## API Reference -[Get Changeset Status](https://developer.bentley.com/apis/changed-elements/operations/get-changesets/) +[Get Changeset Status](https://developer.bentley.com/apis/changed-elements/operations/get-changesets/) \ No newline at end of file diff --git a/docs/changed-elements/comparison.md b/docs/changed-elements/comparison.md index 2130019b..f4c49ac5 100644 --- a/docs/changed-elements/comparison.md +++ b/docs/changed-elements/comparison.md @@ -4,14 +4,6 @@ Compare changes between two changesets in an iModel. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin associated with the iModel. - **Type:** `string` **Required:** Yes - -- **`-m, --imodel-id`** - The ID of the iModel to compare changesets for. - **Type:** `string` **Required:** Yes - - **`--changeset-id1`** The ID of the first changeset to compare. **Type:** `string` **Required:** Yes @@ -20,6 +12,14 @@ Compare changes between two changesets in an iModel. The ID of the second changeset to compare. **Type:** `string` **Required:** Yes +- **`-m, --imodel-id`** + The ID of the iModel to compare changesets for. + **Type:** `string` **Required:** Yes + +- **`-i, --itwin-id`** + The ID of the iTwin associated with the iModel. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -32,4 +32,4 @@ itp changed-elements comparison --itwin-id 89337c07-ab59-4080-81cc-5e237be55369 ## API Reference -[Get Comparison](https://developer.bentley.com/apis/changed-elements/operations/get-comparison/) +[Get Comparison](https://developer.bentley.com/apis/changed-elements/operations/get-comparison/) \ No newline at end of file diff --git a/docs/changed-elements/disable.md b/docs/changed-elements/disable.md index 2ac5c06a..e835a8b6 100644 --- a/docs/changed-elements/disable.md +++ b/docs/changed-elements/disable.md @@ -4,14 +4,14 @@ Disable change tracking for a specified iModel. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin associated with the iModel. - **Type:** `string` **Required:** Yes - - **`-m, --imodel-id`** The ID of the iModel where change tracking should be disabled. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin associated with the iModel. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp changed-elements disable --itwin-id 1a2b3c4d-5678-90ab-cdef-1234567890ab --i ## API Reference -[Disable Change Tracking](https://developer.bentley.com/apis/changed-elements/operations/enable-change-tracking/) +[Disable Change Tracking](https://developer.bentley.com/apis/changed-elements/operations/enable-change-tracking/) \ No newline at end of file diff --git a/docs/changed-elements/enable.md b/docs/changed-elements/enable.md index e7e87396..3ab33e41 100644 --- a/docs/changed-elements/enable.md +++ b/docs/changed-elements/enable.md @@ -4,14 +4,14 @@ Enable change tracking for a specified iModel. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin associated with the iModel. - **Type:** `string` **Required:** Yes - - **`-m, --imodel-id`** The ID of the iModel where change tracking should be enabled. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin associated with the iModel. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp changed-elements enable --itwin-id 1a2b3c4d-5678-90ab-cdef-1234567890ab --im ## API Reference -[Enable Change Tracking](https://developer.bentley.com/apis/changed-elements/operations/enable-change-tracking/) +[Enable Change Tracking](https://developer.bentley.com/apis/changed-elements/operations/enable-change-tracking/) \ No newline at end of file diff --git a/docs/changed-elements/info.md b/docs/changed-elements/info.md index 50e46dc4..60293a09 100644 --- a/docs/changed-elements/info.md +++ b/docs/changed-elements/info.md @@ -4,14 +4,14 @@ Retrieve change tracking information for a specified iModel. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin associated with the iModel. - **Type:** `string` **Required:** Yes - - **`-m, --imodel-id`** The ID of the iModel to retrieve tracking information for. **Type:** `string` **Required:** Yes +- **`-i, --itwin-id`** + The ID of the iTwin associated with the iModel. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp changed-elements info --itwin-id 1a2b3c4d-5678-90ab-cdef-1234567890ab --imod ## API Reference -[Get Tracking Info](https://developer.bentley.com/apis/changed-elements/operations/get-tracking/) +[Get Tracking Info](https://developer.bentley.com/apis/changed-elements/operations/get-tracking/) \ No newline at end of file diff --git a/docs/context/clear.md b/docs/context/clear.md index e0c85467..b61fde9a 100644 --- a/docs/context/clear.md +++ b/docs/context/clear.md @@ -2,9 +2,13 @@ Clear the cached context. +## Options + +(This command does not have any options) + ## Examples ```bash # Example 1: Clear the cached context itp context clear -``` +``` \ No newline at end of file diff --git a/docs/context/info.md b/docs/context/info.md index 866a73dc..a8a85bec 100644 --- a/docs/context/info.md +++ b/docs/context/info.md @@ -2,9 +2,13 @@ Display the cached context. +## Options + +(This command does not have any options) + ## Examples ```bash # Example 1: Display the cached context itp context info -``` +``` \ No newline at end of file diff --git a/docs/context/set.md b/docs/context/set.md index 8354ef05..90e3af4e 100644 --- a/docs/context/set.md +++ b/docs/context/set.md @@ -23,4 +23,4 @@ itp context set --imodel-id 67890 # Example 3: Error when neither --itwin-id nor --imodel-id is provided itp context set -``` +``` \ No newline at end of file diff --git a/docs/imodel/changeset/info.md b/docs/imodel/changeset/info.md index 30251253..13c97f25 100644 --- a/docs/imodel/changeset/info.md +++ b/docs/imodel/changeset/info.md @@ -4,14 +4,14 @@ Retrieve details about a specific changeset of an iModel. ## Options -- **`-m, --imodel-id`** - The ID of the iModel whose changeset you want to retrieve. - **Type:** `string` **Required:** Yes - - **`--changeset-id`** The ID of the changeset. **Type:** `string` **Required:** Yes +- **`-m, --imodel-id`** + The ID of the iModel whose changeset you want to retrieve. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -20,4 +20,4 @@ itp imodel changeset info --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --cha ## API Reference -[Get Changeset Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changeset-details/) +[Get Changeset Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changeset-details/) \ No newline at end of file diff --git a/docs/imodel/changeset/list.md b/docs/imodel/changeset/list.md index bdd991aa..1245c3b2 100644 --- a/docs/imodel/changeset/list.md +++ b/docs/imodel/changeset/list.md @@ -8,24 +8,25 @@ List all changesets for a specific iModel. The ID of the iModel whose changesets you want to list. **Type:** `string` **Required:** Yes -- **`--top`** - The maximum number of changesets to return. +- **`--after-index`** + List changesets after a specific index (exclusive). **Type:** `integer` **Required:** No -- **`--skip`** - The number of changesets to skip. +- **`--last-index`** + List changesets up to a specific index (inclusive). **Type:** `integer` **Required:** No - **`--order-by`** - Order the changesets by their index. Can be `asc` for ascending or `desc` for descending order. - **Type:** `string` **Required:** No + Order the changesets by their index. Can be asc for ascending or desc for descending order. + **Type:** `string` **Required:** No + **Valid Values:** `"asc"`, `"desc"` -- **`--after-index`** - List changesets after a specific index (exclusive). +- **`--skip`** + The number of changesets to skip. **Type:** `integer` **Required:** No -- **`--last-index`** - List changesets up to a specific index (inclusive). +- **`--top`** + The maximum number of changesets to return. **Type:** `integer` **Required:** No ## Examples @@ -46,4 +47,4 @@ itp imodel changeset list --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --las ## API Reference -[List Changesets](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changesets/) +[List Changesets](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changesets/) \ No newline at end of file diff --git a/docs/imodel/connection/auth.md b/docs/imodel/connection/auth.md index 25f88584..2a9820d3 100644 --- a/docs/imodel/connection/auth.md +++ b/docs/imodel/connection/auth.md @@ -4,7 +4,7 @@ Ensures the user has a valid token for long-running connection tasks. This must ## Options -(No options required for this command) +(This command does not have any options) ## Examples @@ -14,4 +14,4 @@ itp imodel connection auth ## API Reference -[Get Authorization Information](https://developer.bentley.com/apis/synchronization/operations/get-authorization-information/) +[Get Authorization Information](https://developer.bentley.com/apis/synchronization/operations/get-authorization-information/) \ No newline at end of file diff --git a/docs/imodel/connection/create.md b/docs/imodel/connection/create.md index c0ec5c9e..e93b51f7 100644 --- a/docs/imodel/connection/create.md +++ b/docs/imodel/connection/create.md @@ -4,28 +4,28 @@ Create a storage connection that describes files from storage to synchronize wit ## Options -- **`-m, --imodel-id`** - The ID of the iModel. - **Type:** `string` **Required:** Yes +- **`--connector-type`** + The connector type of your file. Each connector will be used for the corresponding file in the files list (first connector for the first file, second connector for the second file, and so on). + **Type:** `string` **Required:** Yes **Multiple:** Yes + **Valid Values:** `"AUTOPLANT"`, `"AVEVAPID"`, `"CIVIL"`, `"CIVIL3D"`, `"DWG"`, `"GEOSPATIAL"`, `"IFC"`, `"MSTN"`, `"NWD"`, `"OBD"`, `"OPENTOWER"`, `"REVIT"`, `"SPPID"`, `"SPXREVIEW"` - **`-f, --file-id`** - The ID of the storage file to synchronize. - **Type:** `array` **Required:** Yes **Multiple:** Yes + The ID of the storage file to synchronize + **Type:** `string` **Required:** Yes **Multiple:** Yes -- **`--connector-type`** - The connector type of your file. Each connector will be used for the corresponding file in the files list (first connector for the first file, second connector for the second file, and so on). - **Type:** `array` **Required:** Yes **Multiple:** Yes - **Valid Values:** `"AUTOPLANT", "CIVIL", "CIVIL3D", "DWG", "GEOSPATIAL", "IFC", "MSTN", "NWD", "OBD", "OPENTOWER", "REVIT", "SPPID", "SPXREVIEW"` - -- **`-n, --name`** - The display name of the storage connection. - **Type:** `string` **Required:** No +- **`-m, --imodel-id`** + The ID of the iModel. + **Type:** `string` **Required:** Yes - **`--authentication-type`** The authorization workflow type. **Type:** `string` **Required:** No **Valid Values:** `"User"`, `"Service"` +- **`-n, --name`** + The display name of the storage connection. + **Type:** `string` **Required:** No + ## Examples ```bash @@ -38,4 +38,4 @@ itp imodel connection create --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 -- ## API Reference -[Create Storage Connection](https://developer.bentley.com/apis/synchronization/operations/create-storage-connection/) +[Create Storage Connection](https://developer.bentley.com/apis/synchronization/operations/create-storage-connection/) \ No newline at end of file diff --git a/docs/imodel/connection/delete.md b/docs/imodel/connection/delete.md index d1321cb1..85634a1f 100644 --- a/docs/imodel/connection/delete.md +++ b/docs/imodel/connection/delete.md @@ -16,4 +16,4 @@ itp imodel connection delete --connection-id bf4d8b36-25d7-4b72-b38b-12c1f0325f4 ## API Reference -[Delete Storage Connection](https://developer.bentley.com/apis/synchronization/operations/delete-storage-connection/) +[Delete Storage Connection](https://developer.bentley.com/apis/synchronization/operations/delete-storage-connection/) \ No newline at end of file diff --git a/docs/imodel/connection/info.md b/docs/imodel/connection/info.md index b88f12b4..6cb0c5a8 100644 --- a/docs/imodel/connection/info.md +++ b/docs/imodel/connection/info.md @@ -16,4 +16,4 @@ itp imodel connection info --connection-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 ## API Reference -[Get Storage Connection](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection/) +[Get Storage Connection](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection/) \ No newline at end of file diff --git a/docs/imodel/connection/list.md b/docs/imodel/connection/list.md index b826c633..d051309b 100644 --- a/docs/imodel/connection/list.md +++ b/docs/imodel/connection/list.md @@ -8,14 +8,14 @@ List all storage connections of a specific iModel. The ID of the iModel whose storage connections you want to list. **Type:** `string` **Required:** Yes -- **`--top`** - The maximum number of changesets to return. - **Type:** `integer` **Required:** No - - **`--skip`** The number of changesets to skip. **Type:** `integer` **Required:** No +- **`--top`** + The maximum number of changesets to return. + **Type:** `integer` **Required:** No + ## Examples ```bash @@ -27,9 +27,8 @@ itp imodel connection list --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --to # Example 3: Listing the 5 connections after the first 15 connections are skipped for an iModel itp imodel connection list --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --top 5 --skip 15 - ``` ## API Reference -[Get Storage Connections](https://developer.bentley.com/apis/synchronization/operations/get-storage-connections/) +[Get Storage Connections](https://developer.bentley.com/apis/synchronization/operations/get-storage-connections/) \ No newline at end of file diff --git a/docs/imodel/connection/run/create.md b/docs/imodel/connection/run/create.md index 6d30b3d5..8519b5cb 100644 --- a/docs/imodel/connection/run/create.md +++ b/docs/imodel/connection/run/create.md @@ -17,4 +17,4 @@ itp imodel connection run create --connection-id bf4d8b36-25d7-4b72-b38b-12c1f03 ## API Reference -[Run Storage Connection](https://developer.bentley.com/apis/synchronization/operations/run-storage-connection/) +[Run Storage Connection](https://developer.bentley.com/apis/synchronization/operations/run-storage-connection/) \ No newline at end of file diff --git a/docs/imodel/connection/run/info.md b/docs/imodel/connection/run/info.md index cff4c547..055bd167 100644 --- a/docs/imodel/connection/run/info.md +++ b/docs/imodel/connection/run/info.md @@ -20,4 +20,4 @@ itp imodel connection run info --connection-id abc12345-6789-4321-abcd-987654321 ## API Reference -[Get Storage Connection Run](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-run/) +[Get Storage Connection Run](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-run/) \ No newline at end of file diff --git a/docs/imodel/connection/run/list.md b/docs/imodel/connection/run/list.md index fe60f8bc..0c291ecf 100644 --- a/docs/imodel/connection/run/list.md +++ b/docs/imodel/connection/run/list.md @@ -8,14 +8,14 @@ List all runs for a specific storage connection. The ID of the storage connection. **Type:** `string` **Required:** Yes -- **`--top`** - Limit the number of runs returned. - **Type:** `integer` **Required:** No - - **`--skip`** Skip a number of runs in the result. **Type:** `integer` **Required:** No +- **`--top`** + Limit the number of runs returned. + **Type:** `integer` **Required:** No + ## Examples ```bash @@ -31,4 +31,4 @@ itp imodel connection run list --connection-id bf4d8b36-25d7-4b72-b38b-12c1f0325 ## API Reference -[Get Storage Connection Runs](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-runs/) +[Get Storage Connection Runs](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-runs/) \ No newline at end of file diff --git a/docs/imodel/connection/sourcefile/add.md b/docs/imodel/connection/sourcefile/add.md index 9f48a6b3..0864ef27 100644 --- a/docs/imodel/connection/sourcefile/add.md +++ b/docs/imodel/connection/sourcefile/add.md @@ -8,15 +8,15 @@ Add a source file to an existing storage connection of an iModel. The ID of the storage connection to which the source file will be added. **Type:** `string` **Required:** Yes -- **`--storage-file-id`** - The storage file ID. - **Type:** `string` **Required:** Yes - - **`--connector-type`** The connector type for synchronization. **Type:** `string` **Required:** Yes **Valid Values:** `"AUTOPLANT"`, `"CIVIL"`, `"CIVIL3D"`, `"DWG"`, `"IFC"`, `"MSTN"`, `"REVIT"`, `"OPENROADS"`, `"SPX"`, `"XER"`, `"PRIMAVERA"`, `"SYNCHRO"`, `"MICROSTATION"` +- **`--storage-file-id`** + The storage file ID. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -26,4 +26,4 @@ itp imodel connection sourcefile add --connection-id bf4d8b36-25d7-4b72-b38b-12c ## API Reference -[Add Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/add-storage-connection-sourcefile/) +[Add Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/add-storage-connection-sourcefile/) \ No newline at end of file diff --git a/docs/imodel/connection/sourcefile/delete.md b/docs/imodel/connection/sourcefile/delete.md index 4fba2a4d..e6855f83 100644 --- a/docs/imodel/connection/sourcefile/delete.md +++ b/docs/imodel/connection/sourcefile/delete.md @@ -20,4 +20,4 @@ itp imodel connection sourcefile delete --connection-id bf4d8b36-25d7-4b72-b38b- ## API Reference -[Remove Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/remove-storage-connection-sourcefile/) +[Remove Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/remove-storage-connection-sourcefile/) \ No newline at end of file diff --git a/docs/imodel/connection/sourcefile/info.md b/docs/imodel/connection/sourcefile/info.md index 4da5e219..bdb75d6d 100644 --- a/docs/imodel/connection/sourcefile/info.md +++ b/docs/imodel/connection/sourcefile/info.md @@ -20,4 +20,4 @@ itp imodel connection sourcefile info --connection-id bf4d8b36-25d7-4b72-b38b-12 ## API Reference -[Get Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-sourcefile/) +[Get Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-sourcefile/) \ No newline at end of file diff --git a/docs/imodel/connection/sourcefile/list.md b/docs/imodel/connection/sourcefile/list.md index 71912b1c..4b6d632a 100644 --- a/docs/imodel/connection/sourcefile/list.md +++ b/docs/imodel/connection/sourcefile/list.md @@ -8,14 +8,14 @@ List all source files in a specific storage connection. The ID of the storage connection. **Type:** `string` **Required:** Yes -- **`--top`** - Limit the number of source files returned. - **Type:** `integer` **Required:** No - - **`--skip`** Skip a number of source files in the result. **Type:** `integer` **Required:** No +- **`--top`** + Limit the number of source files returned. + **Type:** `integer` **Required:** No + ## Examples ```bash @@ -31,4 +31,4 @@ itp imodel connection sourcefile list --connection-id bf4d8b36-25d7-4b72-b38b-12 ## API Reference -[Get Storage Connection SourceFiles](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-sourcefiles/) +[Get Storage Connection SourceFiles](https://developer.bentley.com/apis/synchronization/operations/get-storage-connection-sourcefiles/) \ No newline at end of file diff --git a/docs/imodel/connection/sourcefile/update.md b/docs/imodel/connection/sourcefile/update.md index 3846c08c..0a97877b 100644 --- a/docs/imodel/connection/sourcefile/update.md +++ b/docs/imodel/connection/sourcefile/update.md @@ -8,15 +8,15 @@ Update an existing source file in a storage connection of an iModel. The ID of the storage connection. **Type:** `string` **Required:** Yes -- **`--source-file-id`** - The source file ID to update. - **Type:** `string` **Required:** Yes - - **`--connector-type`** The connector type for synchronization. **Type:** `string` **Required:** Yes **Valid Values:** `"AUTOPLANT"`, `"CIVIL"`, `"CIVIL3D"`, `"DWG"`, `"IFC"`, `"MSTN"`, `"REVIT"` +- **`--source-file-id`** + The source file ID to update. + **Type:** `string` **Required:** Yes + ## Examples ```bash @@ -25,4 +25,4 @@ itp imodel connection sourcefile update --connection-id bf4d8b36-25d7-4b72-b38b- ## API Reference -[Update Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/update-storage-connection-sourcefile/) +[Update Storage Connection SourceFile](https://developer.bentley.com/apis/synchronization/operations/update-storage-connection-sourcefile/) \ No newline at end of file diff --git a/docs/imodel/connection/update.md b/docs/imodel/connection/update.md index 9fc0bc3f..7a16bf33 100644 --- a/docs/imodel/connection/update.md +++ b/docs/imodel/connection/update.md @@ -8,15 +8,15 @@ Update an existing storage connection of an iModel. The ID of the storage connection to update. **Type:** `string` **Required:** Yes -- **`-n, --name`** - The new display name for the storage connection. - **Type:** `string` **Required:** No - - **`--authentication-type`** The authorization workflow type. **Type:** `string` **Required:** No **Valid Values:** `"User"`, `"Service"` +- **`-n, --name`** + The new display name for the storage connection. + **Type:** `string` **Required:** No + ## Examples ```bash @@ -29,4 +29,4 @@ itp imodel connection update --connection-id bf4d8b36-25d7-4b72-b38b-12c1f0325f4 ## API Reference -[Update Storage Connection](https://developer.bentley.com/apis/synchronization/operations/update-storage-connection/) +[Update Storage Connection](https://developer.bentley.com/apis/synchronization/operations/update-storage-connection/) \ No newline at end of file diff --git a/docs/imodel/delete.md b/docs/imodel/delete.md index 3e15bd1d..6100e8b8 100644 --- a/docs/imodel/delete.md +++ b/docs/imodel/delete.md @@ -16,4 +16,4 @@ itp imodel delete --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d ## API Reference -[Delete iModel](https://developer.bentley.com/apis/imodels-v2/operations/delete-imodel/) +[Delete iModel](https://developer.bentley.com/apis/imodels-v2/operations/delete-imodel/) \ No newline at end of file diff --git a/docs/imodel/info.md b/docs/imodel/info.md index 3c7c6eb0..1bb79437 100644 --- a/docs/imodel/info.md +++ b/docs/imodel/info.md @@ -16,4 +16,4 @@ itp imodel info --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d ## API Reference -[Get iModel Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/) +[Get iModel Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/) \ No newline at end of file diff --git a/docs/imodel/list.md b/docs/imodel/list.md index bb37dcb5..af709022 100644 --- a/docs/imodel/list.md +++ b/docs/imodel/list.md @@ -8,13 +8,9 @@ Retrieve a list of iModels belonging to the specified iTwin. The ID of the iTwin to list iModels for. **Type:** `string` **Required:** Yes -- **`--skip`** - Skip a number of items in the result. - **Type:** `integer` **Required:** No - -- **`--top`** - Limit the number of items returned. - **Type:** `integer` **Required:** No +- **`-n, --name`** + Filter iModels by their exact name. + **Type:** `string` **Required:** No - **`--order-by`** Order the results by 'name' or 'createdDateTime'. Use 'asc' for ascending or 'desc' for descending order. @@ -24,15 +20,19 @@ Retrieve a list of iModels belonging to the specified iTwin. Filter iModels by a string in their name or description. **Type:** `string` **Required:** No -- **`-n, --name`** - Filter iModels by their exact name. - **Type:** `string` **Required:** No +- **`--skip`** + Skip a number of items in the result. + **Type:** `integer` **Required:** No - **`--state`** Filter iModels by their state. **Type:** `string` **Required:** No **Valid Values:** `"initialized"`, `"notInitialized"` +- **`--top`** + Limit the number of items returned. + **Type:** `integer` **Required:** No + ## Examples ```bash @@ -51,4 +51,4 @@ itp imodel list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --state initiali ## API Reference -[List iModels](https://developer.bentley.com/apis/imodels-v2/operations/get-itwin-imodels/) +[List iModels](https://developer.bentley.com/apis/imodels-v2/operations/get-itwin-imodels/) \ No newline at end of file diff --git a/docs/imodel/named-version/create.md b/docs/imodel/named-version/create.md index 90711d8c..a8c41681 100644 --- a/docs/imodel/named-version/create.md +++ b/docs/imodel/named-version/create.md @@ -35,4 +35,4 @@ itp imodel named-version create --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 ## API Reference -[Create Named Version](https://developer.bentley.com/apis/imodels-v2/operations/create-imodel-named-version/) +[Create Named Version](https://developer.bentley.com/apis/imodels-v2/operations/create-imodel-named-version/) \ No newline at end of file diff --git a/docs/imodel/named-version/info.md b/docs/imodel/named-version/info.md index 2e9c189b..4b61a095 100644 --- a/docs/imodel/named-version/info.md +++ b/docs/imodel/named-version/info.md @@ -20,4 +20,4 @@ itp imodel named-version info --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 - ## API Reference -[Get Named Version Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-named-version-details/) +[Get Named Version Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-named-version-details/) \ No newline at end of file diff --git a/docs/imodel/named-version/list.md b/docs/imodel/named-version/list.md index 00def86c..41879c12 100644 --- a/docs/imodel/named-version/list.md +++ b/docs/imodel/named-version/list.md @@ -8,13 +8,9 @@ List all named versions for a specific iModel. The ID of the iModel whose named versions you want to list. **Type:** `string` **Required:** Yes -- **`--top`** - Limit the number of named versions returned. - **Type:** `integer` **Required:** No - -- **`--skip`** - Skip a number of named versions in the result. - **Type:** `integer` **Required:** No +- **`-n, --name`** + Filter named versions by exact name. + **Type:** `string` **Required:** No - **`--order-by`** Sort by `changesetIndex` or `createdDateTime`, in `asc` or `desc` order. @@ -24,9 +20,13 @@ List all named versions for a specific iModel. Search named versions by name or description. **Type:** `string` **Required:** No -- **`-n, --name`** - Filter named versions by exact name. - **Type:** `string` **Required:** No +- **`--skip`** + Skip a number of named versions in the result. + **Type:** `integer` **Required:** No + +- **`--top`** + Limit the number of named versions returned. + **Type:** `integer` **Required:** No ## Examples @@ -46,4 +46,4 @@ itp imodel named-version list --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 - ## API Reference -[Get Named Versions](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-named-versions/) +[Get Named Versions](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-named-versions/) \ No newline at end of file diff --git a/docs/imodel/populate.md b/docs/imodel/populate.md index b97a9ccd..a358f04e 100644 --- a/docs/imodel/populate.md +++ b/docs/imodel/populate.md @@ -4,23 +4,23 @@ Synchronize design files into an iModel. ## Options +- **`-f, --file`** + Specify a list of source files to synchronize into the iModel. + **Type:** `string` **Required:** Yes **Multiple:** Yes + - **`-m, --imodel-id`** The ID of the iModel to populate. **Type:** `string` **Required:** Yes -- **`--file`** - A list of source files to synchronize into the iModel. - **Type:** `string` **Required:** Yes **Multiple:** Yes +- **`-c, --connector-type`** + Specify connectors to prioritize for synchronization. This flag can be provided multiple times. If only one connector is specified, it will be used for all files. If multiple connectors are specified, each connector will be used for the corresponding file in the files list (first connector for the first file, second connector for the second file, and so on). + **Type:** `string` **Required:** No **Multiple:** Yes + **Valid Values:** `"AUTOPLANT"`, `"AVEVAPID"`, `"CIVIL"`, `"CIVIL3D"`, `"DWG"`, `"GEOSPATIAL"`, `"IFC"`, `"MSTN"`, `"NWD"`, `"OBD"`, `"OPENTOWER"`, `"REVIT"`, `"SPPID"`, `"SPXREVIEW"` -- **`--no-wait`** +- **`--no-wait`** Do not wait for the synchronization process to complete. **Type:** `flag` **Required:** No -- **`--connector-type`** - Specify connectors to prioritize for synchronization. This flag can be provided multiple times. If only one connector is specified, it will be used for all files. If multiple connectors are specified, each connector will be used for the corresponding file in the files list (first connector for the first file, second connector for the second file, and so on). - **Type:** `string` **Required:** No **Multiple:** Yes - **Valid Values:** `"SHELLEDWCSV"`, `"CIVIL"`, `"MSTN"`, `"OBD"`, `"PROSTRUCTURES"`, `"AUTOPLANT"`, `"AVEVAPID"`, `"CIVIL3D"`, `"DWG"`, `"IFC"`, `"GEOSPATIAL"`, `"OPENTOWER"`, `"REVIT"`, `"SPPID"`, `"SPXREVIEW"`, `"AVEVADIAGRAMS"`, `"NWD"`, `"INTELLIPID"`, `"PSEXCEL"` - ## Examples ```bash @@ -39,4 +39,4 @@ itp imodel populate --imodel-id i9j0k1l2-3456-78ab-cdef-9012345678ij --file mode ## Workflow Reference -- [iModel Populate](/docs/command-workflows/imodel-populate) +[iModel Populate](/docs/command-workflows/imodel-populate) \ No newline at end of file diff --git a/docs/imodel/view/cesium-sandcastle.md b/docs/imodel/view/cesium-sandcastle.md index 37105366..7209347c 100644 --- a/docs/imodel/view/cesium-sandcastle.md +++ b/docs/imodel/view/cesium-sandcastle.md @@ -1,22 +1,21 @@ # itp imodel view cesium-sandcastle > 🔬 This command is currently in Technical Preview. - Setup iModel and get URL to view it in Cesium Sandcastle. ## Options -- **`--changeset-id`** - Changeset id to be viewed in Cesium Sandcastle. If not provided, the latest changeset will be used. - **Type:** `string` **Required:** No - - **`-m, --imodel-id`** iModel id to be viewed in Cesium Sandcastle. **Type:** `string` **Required:** Yes +- **`--changeset-id`** + Changeset id to be viewed in Cesium Sandcastle. If not provided, the latest changeset will be used. + **Type:** `string` **Required:** No + - **`--open`** Open the URL in the browser. - **Type:** `boolean` **Required:** No + **Type:** `flag` **Required:** No ## Examples @@ -33,4 +32,4 @@ itp imodel view cesium-sandcastle --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee ## Workflow Reference -[Cesium Sandcastle](/docs/command-workflows/cesium-sandcastle) +[Cesium Sandcastle](/docs/command-workflows/cesium-sandcastle) \ No newline at end of file diff --git a/docs/itwin/delete.md b/docs/itwin/delete.md index 325d71e4..281ced8d 100644 --- a/docs/itwin/delete.md +++ b/docs/itwin/delete.md @@ -16,4 +16,4 @@ itp itwin delete --itwin-id b1a2c3d4-5678-90ab-cdef-1234567890ab ## API Reference -[Delete iTwin](https://developer.bentley.com/apis/itwins/operations/delete-itwin/) +[Delete iTwin](https://developer.bentley.com/apis/itwins/operations/delete-itwin/) \ No newline at end of file diff --git a/docs/itwin/info.md b/docs/itwin/info.md index 03f7dcce..25987f0b 100644 --- a/docs/itwin/info.md +++ b/docs/itwin/info.md @@ -16,4 +16,4 @@ itp itwin info --itwin-id b1a2c3d4-5678-90ab-cdef-1234567890ab ## API Reference -[Get iTwin Details](https://developer.bentley.com/apis/itwins/operations/get-itwin/) +[Get iTwin Details](https://developer.bentley.com/apis/iTwins/operations/get-itwin/) \ No newline at end of file diff --git a/docs/itwin/list.md b/docs/itwin/list.md index 49e3e589..63864dde 100644 --- a/docs/itwin/list.md +++ b/docs/itwin/list.md @@ -4,51 +4,51 @@ List all iTwins the calling user is a member of. ## Options -- **`--sub-class`** - Filter by the subClass of the iTwin. - **Type:** `string` **Required:** No - **Valid Values:** `"Account"`, `"Portfolio"`, `"Asset"`, `"Program"`, `"Project"`, `"WorkPackage"` +- **`--include-inactive`** + Include Inactive iTwins in the result. + **Type:** `flag` **Required:** No -- **`--status`** - Filter by the status of the iTwin. - **Type:** `string` **Required:** No - **Valid Values:** `"Active"`, `"Inactive"`, `"Trial"` +- **`--itwin-account-id`** + Filter by the iTwin Account ID. + **Type:** `string` **Required:** No -- **`--type`** - Filter by the iTwin's Type. +- **`-n, --name`** + Find iTwins with the exact display name specified. **Type:** `string` **Required:** No - **`--number`** Find iTwins with the exact number specified. **Type:** `string` **Required:** No -- **`-n, --name`** - Find iTwins with the exact display name specified. - **Type:** `string` **Required:** No - - **`--parent-id`** Filter by the parent iTwin ID. **Type:** `string` **Required:** No -- **`--itwin-account-id`** - Filter by the iTwin Account ID. - **Type:** `string` **Required:** No - - **`--search`** Search iTwins by a string in the number or display name. **Type:** `string` **Required:** No -- **`--top`** - Limit the number of items returned. - **Type:** `integer` **Required:** No - - **`--skip`** Skip a number of items in the result. **Type:** `integer` **Required:** No -- **`--include-inactive`** - Include inactive iTwins in the result. - **Type:** `flag` **Required:** No +- **`--status`** + Filter by the status of the iTwin. + **Type:** `string` **Required:** No + **Valid Values:** `"Active"`, `"Inactive"`, `"Trial"` + +- **`--sub-class`** + Filter by a specific iTwin subClass. + **Type:** `string` **Required:** No + **Valid Values:** `"Account"`, `"Asset"`, `"Project"`, `"Portfolio"`, `"Program"`, `"WorkPackage"` + +- **`--top`** + Limit the number of items returned. + **Type:** `integer ` **Required:** No + +- **`--type`** + Filter by the iTwin's Type. + **Type:** `string` **Required:** No ## Examples @@ -71,4 +71,4 @@ itp itwin list --sub-class WorkPackage --parent-id b1a2c3d4-5678-90ab-cdef-12345 ## API Reference -[List iTwins](https://developer.bentley.com/apis/itwins/operations/get-my-itwins/) +[List iTwins](https://developer.bentley.com/apis/itwins/operations/get-my-itwins/) \ No newline at end of file diff --git a/docs/itwin/repository/create.md b/docs/itwin/repository/create.md index c6a66382..8a210779 100644 --- a/docs/itwin/repository/create.md +++ b/docs/itwin/repository/create.md @@ -4,24 +4,24 @@ Create a new repository URI for iTwin data. ## Options -- **`-i, --itwin-id`** - The ID of the iTwin to which the repository belongs. - **Type:** `string` **Required:** Yes - - **`--class`** The class of your iTwin repository. **Type:** `string` **Required:** Yes **Valid Values:** `"GeographicInformationSystem"`, `"Construction"`, `"Subsurface"` -- **`--sub-class`** - The subClass of your repository. - **Type:** `string` **Required:** Yes - **Valid Values:** `"WebMapService"`, `"WebMapTileService"`, `"MapServer"`, `"Performance"`, `"EvoWorkspace"` +- **`-i, --itwin-id`** + The ID of the iTwin to which the repository belongs. + **Type:** `string` **Required:** Yes - **`--uri`** The URI to the custom repository. **Type:** `string` **Required:** Yes +- **`--sub-class`** + The subClass of your repository. + **Type:** `string` **Required:** No + **Valid Values:** `"WebMapService"`, `"WebMapTileService"`, `"MapServer"`, `"Performance"`, `"EvoWorkspace"` + ## Examples ```bash @@ -37,4 +37,4 @@ itp itwin repository create --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --cl ## API Reference -[Create Repository](https://developer.bentley.com/apis/iTwins/operations/create-repository/) +[Create Repository](https://developer.bentley.com/apis/iTwins/operations/create-repository/) \ No newline at end of file diff --git a/docs/itwin/repository/delete.md b/docs/itwin/repository/delete.md index 8fee90ef..64135169 100644 --- a/docs/itwin/repository/delete.md +++ b/docs/itwin/repository/delete.md @@ -20,4 +20,4 @@ itp itwin repository delete --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --re ## API Reference -[Delete Repository](https://developer.bentley.com/apis/iTwins/operations/delete-repository/) +[Delete Repository](https://developer.bentley.com/apis/iTwins/operations/delete-repository/) \ No newline at end of file diff --git a/docs/itwin/repository/list.md b/docs/itwin/repository/list.md index 2fd574ed..3c71bcfa 100644 --- a/docs/itwin/repository/list.md +++ b/docs/itwin/repository/list.md @@ -14,7 +14,7 @@ Retrieve a list of repositories for a specified iTwin. **Valid Values:** `"iModels"`, `"RealityData"`, `"Storage"`, `"Forms"`, `"Issues"`, `"SensorData"`, `"GeographicInformationSystem"`, `"Construction"`, `"Subsurface"` - **`--sub-class`** - Specify a subClass of repositories. Only applicable for **`GeographicInformationSystem`** class. + Specify a subClass of repositories. Only applicable for **`GeographicInformationSystem`** class. **Type:** `string` **Required:** No **Valid Values:** `"WebMapService"`, `"WebMapTileService"`, `"MapServer"` @@ -33,4 +33,4 @@ itp itwin repository list --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --clas ## API Reference -[List Repositories](https://developer.bentley.com/apis/itwins/operations/get-repositories-by-itwin-id/) +[List Repositories](https://developer.bentley.com/apis/itwins/operations/get-repositories-by-itwin-id/) \ No newline at end of file diff --git a/docs/itwin/update.md b/docs/itwin/update.md index 271928a0..1f085330 100644 --- a/docs/itwin/update.md +++ b/docs/itwin/update.md @@ -8,18 +8,6 @@ Update the specified iTwin. Only include properties you want to update. The ID of the iTwin to be updated. **Type:** `string` **Required:** Yes -- **`-n, --name`** - The iTwin's display name. - **Type:** `string **Required:** No - -- **`--type`** - Open ended property to define your iTwin's type. - **Type:** `string` **Required:** No - -- **`--number`** - Unique identifier for the iTwin. - **Type:** `string` **Required:** No - - **`--geographic-location`** Optional location, typically an address or city. **Type:** `string` **Required:** No @@ -28,11 +16,23 @@ Update the specified iTwin. Only include properties you want to update. Optional IANA time zone ID. **Type:** `string` **Required:** No +- **`-n, --name`** + The iTwin's display name. + **Type:** `string` **Required:** No + +- **`--number`** + Unique identifier for the iTwin. + **Type:** `string` **Required:** No + - **`--status`** Status of the iTwin. Defaults to Active. - **Type:** `iTwinStatus` **Required:** No + **Type:** `string` **Required:** No **Valid Values:** `"Active"`, `"Inactive"`, `"Trial"` +- **`--type`** + Open ended property to define your iTwin's type. + **Type:** `string` **Required:** No + ## Examples ```bash @@ -48,4 +48,4 @@ itp itwin update --itwin-id b1a2c3d4-5678-90ab-cdef-1234567890ab --status Inacti ## API Reference -[Update iTwin](https://developer.bentley.com/apis/itwins/operations/update-itwin/) +[Update iTwin](https://developer.bentley.com/apis/itwins/operations/update-itwin/) \ No newline at end of file diff --git a/docs/storage/file/create.md b/docs/storage/file/create.md index 80c24f76..11ee8e50 100644 --- a/docs/storage/file/create.md +++ b/docs/storage/file/create.md @@ -28,4 +28,4 @@ itp storage file create --folder-id abc12345-6789-4321-abcd-9876543210ef --name ## API Reference -[Create File](https://developer.bentley.com/apis/storage/operations/create-file/) +[Create File](https://developer.bentley.com/apis/storage/operations/create-file/) \ No newline at end of file diff --git a/docs/storage/file/delete.md b/docs/storage/file/delete.md index 47abafbe..e5db2f34 100644 --- a/docs/storage/file/delete.md +++ b/docs/storage/file/delete.md @@ -16,4 +16,4 @@ itp storage file delete --file-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 ## API Reference -[Delete File](https://developer.bentley.com/apis/storage/operations/delete-file/) +[Delete File](https://developer.bentley.com/apis/storage/operations/delete-file/) \ No newline at end of file diff --git a/docs/storage/file/info.md b/docs/storage/file/info.md index a4b009dc..ff094795 100644 --- a/docs/storage/file/info.md +++ b/docs/storage/file/info.md @@ -16,4 +16,4 @@ itp storage file info --file-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 ## API Reference -[Get File Info](https://developer.bentley.com/apis/storage/operations/get-file/) +[Get File](https://developer.bentley.com/apis/storage/operations/get-file/) \ No newline at end of file diff --git a/docs/storage/file/list.md b/docs/storage/file/list.md index c8222713..dc03db42 100644 --- a/docs/storage/file/list.md +++ b/docs/storage/file/list.md @@ -24,5 +24,6 @@ itp storage file list --folder-id b1a2c3d4-5678-90ab-cdef-1234567890ab --include ## API Reference -[List Files in Folder](https://developer.bentley.com/apis/storage/operations/get-files-in-folder/) -[List Files and Folders](https://developer.bentley.com/apis/storage/operations/get-folders-and-files-in-folder/) +[List Files in Folder](https://developer.bentley.com/apis/storage/operations/get-files-in-folder/) + +[List Files and Folders in Folder](https://developer.bentley.com/apis/storage/operations/get-folders-and-files-in-folder/) \ No newline at end of file diff --git a/docs/storage/file/update-complete.md b/docs/storage/file/update-complete.md index d6e5e648..d7c7792f 100644 --- a/docs/storage/file/update-complete.md +++ b/docs/storage/file/update-complete.md @@ -5,7 +5,7 @@ Complete the file creation or content update process by marking the operation as ## Options - **`-f, --file-id`** - The ID of the file for which the creation or update is being completed. + The ID of the file for which the creation or update is being completed. **Type:** `string` **Required:** Yes ## Examples @@ -17,4 +17,4 @@ itp storage file update-complete --file-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 ## API Reference -[Complete File Creation](https://developer.bentley.com/apis/storage/operations/complete-file-creation/) +[Complete File Creation](https://developer.bentley.com/apis/storage/operations/complete-file-creation/) \ No newline at end of file diff --git a/docs/storage/file/update-content.md b/docs/storage/file/update-content.md index d0c28d61..2af29e83 100644 --- a/docs/storage/file/update-content.md +++ b/docs/storage/file/update-content.md @@ -17,4 +17,4 @@ itp storage file update-content --file-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 ## API Reference -[Update File Content](https://developer.bentley.com/apis/storage/operations/update-file-content/) +[Update File Content](https://developer.bentley.com/apis/storage/operations/update-file-content/) \ No newline at end of file diff --git a/docs/storage/file/update.md b/docs/storage/file/update.md index e28908d5..19b27770 100644 --- a/docs/storage/file/update.md +++ b/docs/storage/file/update.md @@ -8,14 +8,14 @@ Update the metadata of a file in an iTwin's storage, such as display name or des The ID of the file to be updated. **Type:** `string` **Required:** Yes -- **`-n, --name`** - The new display name for the file. - **Type:** `string` **Required:** No - - **`-d, --description`** A description for the file. **Type:** `string` **Required:** No +- **`-n, --name`** + The new display name for the file. + **Type:** `string` **Required:** No + ## Examples ```bash @@ -28,4 +28,4 @@ itp storage file update --file-id c9f2b8a5-345d-4cfa-b3e5-123456789abc --name "N ## API Reference -[Update File](https://developer.bentley.com/apis/storage/operations/update-file/) +[Update File](https://developer.bentley.com/apis/storage/operations/update-file/) \ No newline at end of file diff --git a/docs/storage/file/upload.md b/docs/storage/file/upload.md index 9fb9a83f..303f1ac7 100644 --- a/docs/storage/file/upload.md +++ b/docs/storage/file/upload.md @@ -4,12 +4,12 @@ Upload a new file to a specified URL within iTwin storage. ## Options -- **`--upload-url`** - The URL where the file should be uploaded. +- **`-f, --file-path`** + The path to the file you want to upload. **Type:** `string` **Required:** Yes -- **`--file-path`** - The path to the file you want to upload. +- **`-u, --upload-url`** + The URL where the file should be uploaded. **Type:** `string` **Required:** Yes ## Examples @@ -24,4 +24,4 @@ itp storage file upload --upload-url https://example.com/image-upload-url --file ## API Reference -[Upload File](https://developer.bentley.com/apis/storage/operations/upload-file/) +[Upload File](https://developer.bentley.com/apis/storage/operations/upload-file/) \ No newline at end of file diff --git a/docs/storage/folder/create.md b/docs/storage/folder/create.md index 6b77a923..49b38431 100644 --- a/docs/storage/folder/create.md +++ b/docs/storage/folder/create.md @@ -4,14 +4,14 @@ Create a new folder in a specified parent folder in iTwin's storage. ## Options -- **`--parent-folder-id`** - The ID of the parent folder where the new folder will be created. - **Type:** `string` **Required:** Yes - - **`-n, --name`** The display name of the folder to be created. **Type:** `string` **Required:** Yes +- **`--parent-folder-id`** + The ID of the parent folder where the new folder will be created. + **Type:** `string` **Required:** Yes + - **`-d, --description`** A description of the folder. **Type:** `string` **Required:** No @@ -20,7 +20,7 @@ Create a new folder in a specified parent folder in iTwin's storage. ```bash # Example 1: Create a folder inside the root folder with a description -# Note: You can retrieve the root folder ID using the 'itp storage root-folder' command. +#Note: You can retrieve the root folder ID using the 'itp storage root-folder' command. itp storage folder create --parent-folder-id ROOT_FOLDER_ID_HERE --name "Project Documents" --description "Folder for all project-related documents" # Example 2: Create a subfolder inside an existing folder @@ -29,4 +29,4 @@ itp storage folder create --parent-folder-id b2c3d4e5-6789-01ab-cdef-2345678901b ## API Reference -[Create Folder](https://developer.bentley.com/apis/storage/operations/create-folder/) +[Create Folder](https://developer.bentley.com/apis/storage/operations/create-folder/) \ No newline at end of file diff --git a/docs/storage/folder/delete.md b/docs/storage/folder/delete.md index 9ca7f44a..8aef28cf 100644 --- a/docs/storage/folder/delete.md +++ b/docs/storage/folder/delete.md @@ -16,4 +16,4 @@ itp storage folder delete --folder-id a1b2c3d4-5678-90ab-cdef-1234567890ab ## API Reference -[Delete Folder](https://developer.bentley.com/apis/storage/operations/delete-folder/) +[Delete Folder](https://developer.bentley.com/apis/storage/operations/delete-folder/) \ No newline at end of file diff --git a/docs/storage/folder/info.md b/docs/storage/folder/info.md index 4078ce74..54a9d3bb 100644 --- a/docs/storage/folder/info.md +++ b/docs/storage/folder/info.md @@ -16,4 +16,4 @@ itp storage folder info --folder-id a1b2c3d4-5678-90ab-cdef-1234567890ab ## API Reference -[Get Folder Info](https://developer.bentley.com/apis/storage/operations/get-folder/) +[Get Folder Info](https://developer.bentley.com/apis/storage/operations/get-folder/) \ No newline at end of file diff --git a/docs/storage/folder/list.md b/docs/storage/folder/list.md index ab188684..f54e90ad 100644 --- a/docs/storage/folder/list.md +++ b/docs/storage/folder/list.md @@ -24,5 +24,6 @@ itp storage folder list --folder-id a1b2c3d4-5678-90ab-cdef-1234567890ab --inclu ## API Reference -[List Folders in Folder](https://developer.bentley.com/apis/storage/operations/get-folders-in-folder/) -[List Folders and Files in Folder](https://developer.bentley.com/apis/storage/operations/get-folders-and-files-in-folder/) +[List Folders in Folder](https://developer.bentley.com/apis/storage/operations/get-folders-in-folder/) + +[List Folders and Files in Folder](https://developer.bentley.com/apis/storage/operations/get-folders-and-files-in-folder/) \ No newline at end of file diff --git a/docs/storage/folder/update.md b/docs/storage/folder/update.md index bbbc3ffc..8495d2d6 100644 --- a/docs/storage/folder/update.md +++ b/docs/storage/folder/update.md @@ -8,14 +8,14 @@ Update the metadata of a folder in an iTwin's storage, such as its display name The ID of the folder to be updated. **Type:** `string` **Required:** Yes -- **`-n, --name`** - The new display name for the folder. - **Type:** `string` **Required:** No - - **`-d, --description`** A description for the folder. **Type:** `string` **Required:** No +- **`-n, --name`** + The new display name for the folder. + **Type:** `string` **Required:** No + ## Examples ```bash @@ -28,4 +28,4 @@ itp storage folder update --folder-id b2c3d4e5-6789-01ab-cdef-2345678901bc --nam ## API Reference -[Update Folder](https://developer.bentley.com/apis/storage/operations/update-folder/) +[Update Folder](https://developer.bentley.com/apis/storage/operations/update-folder/) \ No newline at end of file diff --git a/docs/storage/root-folder.md b/docs/storage/root-folder.md index 869b1158..543cee31 100644 --- a/docs/storage/root-folder.md +++ b/docs/storage/root-folder.md @@ -8,6 +8,14 @@ Retrieve the top-level folders and files in an iTwin's storage. The ID of the iTwin whose top-level folders and files you want to retrieve. **Type:** `string` **Required:** Yes +- **`--skip`** + The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. + **Type:** `integer` **Required:** No + +- **`--top`** + The top system query option requests the number of items in the queried collection to be included in the result. + **Type:** `integer` **Required:** No + ## Examples ```bash @@ -16,4 +24,4 @@ itp storage root-folder --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 ## API Reference -[Get Top-Level Folders and Files](https://developer.bentley.com/apis/storage/operations/get-top-level-folders-and-files-by-project/) +[Get Top-Level Folders and Files](https://developer.bentley.com/apis/storage/operations/get-top-level-folders-and-files-by-project/) \ No newline at end of file diff --git a/docs/user/me.md b/docs/user/me.md index 73e607a4..7ebb4c0c 100644 --- a/docs/user/me.md +++ b/docs/user/me.md @@ -4,7 +4,7 @@ Retrieve information about the currently authenticated user. ## Options -(No options required for this command) +(This command does not have any options) ## Examples @@ -14,4 +14,4 @@ itp user me ## API Reference -[User Me](https://developer.bentley.com/apis/users/operations/me/) +[User Me](https://developer.bentley.com/apis/users/operations/me/) \ No newline at end of file diff --git a/docs/user/search.md b/docs/user/search.md index 7f65cad2..91a8b4de 100644 --- a/docs/user/search.md +++ b/docs/user/search.md @@ -20,4 +20,4 @@ itp user search --search john.doe@example.com ## API Reference -[Search Users](https://developer.bentley.com/apis/users/operations/get-users/) +[Search Users](https://developer.bentley.com/apis/users/operations/get-users/) \ No newline at end of file diff --git a/src/commands/docs-generator.ts b/src/commands/docs-generator.ts index 75928662..5cbe45ad 100644 --- a/src/commands/docs-generator.ts +++ b/src/commands/docs-generator.ts @@ -56,14 +56,15 @@ export default class DocsGenerator extends BaseCommand { let examplesText = ""; - if (command.examples){ + if (command.examples) { for (const example of command.examples) { if (typeof example === "string") { examplesText += `\n${example}`; } - - if(typeof example === "object") { - examplesText += `\n# ${example.description}\n${example.command}\n`; + + if (typeof example === "object") { + // Do not display description for examples where only "Example #:" is present + examplesText += example.description.slice(0, -2) === "Example " ? `\n${example.command}\n` : `\n# ${example.description}\n${example.command}\n`; } } } @@ -86,7 +87,7 @@ export default class DocsGenerator extends BaseCommand { returnContent.push(options); } else { - returnContent.push("(No options required for this command)"); + returnContent.push("(This command does not have any options)"); } returnContent.push('## Examples',