Skip to content

Commit 21eecfa

Browse files
committed
Renamed display-name parameters in commands to name
1 parent a239afd commit 21eecfa

44 files changed

Lines changed: 110 additions & 110 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/access-control/role/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Create a new role for an iTwin. To assign permissions after creation, use `itp a
88
The ID of the iTwin for which the role is being created.
99
**Type:** `string` **Required:** Yes
1010

11-
- **`-n, --display-name`**
11+
- **`-n, --name`**
1212
The name of the role to be created.
1313
**Type:** `string` **Required:** Yes
1414

@@ -19,7 +19,7 @@ Create a new role for an iTwin. To assign permissions after creation, use `itp a
1919
## Examples
2020

2121
```bash
22-
itp access-control role create --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --display-name "Project Manager" --description "Manages all aspects of the project"
22+
itp access-control role create --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --name "Project Manager" --description "Manages all aspects of the project"
2323
```
2424

2525
## API Reference

docs/access-control/role/update.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Update the details of an existing role in an iTwin.
1212
The ID of the role to be updated.
1313
**Type:** `string` **Required:** Yes
1414

15-
- **`-n, --display-name`**
15+
- **`-n, --name`**
1616
The updated name of the role.
1717
**Type:** `string` **Required:** No
1818

@@ -28,10 +28,10 @@ Update the details of an existing role in an iTwin.
2828

2929
```bash
3030
# Example 1: Update role name and description
31-
itp access-control role update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --role-id role1-id --display-name "Lead Engineer" --description "Oversees engineering tasks"
31+
itp access-control role update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --role-id role1-id --name "Lead Engineer" --description "Oversees engineering tasks"
3232

3333
# Example 2: Update role permissions along with the name
34-
itp access-control role update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --role-id role1-id --display-name "Admin Role" --permissions Permission1 --permissions Permission2 --permissions Permission3
34+
itp access-control role update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --role-id role1-id --name "Admin Role" --permissions Permission1 --permissions Permission2 --permissions Permission3
3535
```
3636

3737
## API Reference

docs/imodel/connection/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Create a storage connection that describes files from storage to synchronize wit
1717
**Type:** `array` **Required:** Yes **Multiple:** Yes
1818
**Valid Values:** `"AUTOPLANT", "CIVIL", "CIVIL3D", "DWG", "GEOSPATIAL", "IFC", "MSTN", "NWD", "OBD", "OPENTOWER", "REVIT", "SPPID", "SPXREVIEW"`
1919

20-
- **`-n, --display-name`**
20+
- **`-n, --name`**
2121
The display name of the storage connection.
2222
**Type:** `string` **Required:** No
2323

@@ -33,7 +33,7 @@ Create a storage connection that describes files from storage to synchronize wit
3333
itp imodel connection create --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --file-id t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA --connector-type MSTN
3434

3535
# Example 2: Creating a connection with Service authentication
36-
itp imodel connection create --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --display-name "Engineering Files" --authentication-type Service --file-id t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA --connector-type MSTN --file-id g4ec1dc8c4f6173004f9f881914a57c5511a336d --connector-type DWG
36+
itp imodel connection create --imodel-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --name "Engineering Files" --authentication-type Service --file-id t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA --connector-type MSTN --file-id g4ec1dc8c4f6173004f9f881914a57c5511a336d --connector-type DWG
3737
```
3838

3939
## API Reference

docs/imodel/connection/update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Update an existing storage connection of an iModel.
88
The ID of the storage connection to update.
99
**Type:** `string` **Required:** Yes
1010

11-
- **`-n, --display-name`**
11+
- **`-n, --name`**
1212
The new display name for the storage connection.
1313
**Type:** `string` **Required:** No
1414

@@ -21,7 +21,7 @@ Update an existing storage connection of an iModel.
2121

2222
```bash
2323
# Example 1: Updating a connection with a new display name
24-
itp imodel connection update --connection-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --display-name "Updated Project Files"
24+
itp imodel connection update --connection-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --name "Updated Project Files"
2525

2626
# Example 2: Changing authentication type for a connection
2727
itp imodel connection update --connection-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --authentication-type Service

docs/itwin/create.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Create a new iTwin with specified properties.
1717
- For **`Endeavor`**: `"Project"`, `"Program"`, `"WorkPackage"`
1818
- For **`Account`**: `"Account"`
1919

20-
- **`-n, --display-name`**
20+
- **`-n, --name`**
2121
The iTwin's display name.
2222
**Type:** `string` **Required:** Yes
2323

@@ -55,13 +55,13 @@ Create a new iTwin with specified properties.
5555

5656
```bash
5757
# Example 1: Creating an iTwin with the 'Thing' class and 'Asset' subclass
58-
itp itwin create --class Thing --sub-class Asset --display-name "Golden Gate Revamp"
58+
itp itwin create --class Thing --sub-class Asset --name "Golden Gate Revamp"
5959

6060
# Example 2: Creating an iTwin with the 'Endeavor' class and 'Project' subclass
61-
itp itwin create --class Endeavor --sub-class Project --display-name "Bridge Construction" --geographic-location "San Francisco, CA" --iana-time-zone America/Los_Angeles
61+
itp itwin create --class Endeavor --sub-class Project --name "Bridge Construction" --geographic-location "San Francisco, CA" --iana-time-zone America/Los_Angeles
6262

6363
# Example 3: Creating an iTwin with data center location and status set to 'Trial'
64-
itp itwin create --class Endeavor --sub-class Program --display-name "Rail Network" --data-center-location "UK South" --status Trial
64+
itp itwin create --class Endeavor --sub-class Program --name "Rail Network" --data-center-location "UK South" --status Trial
6565
```
6666

6767
## API Reference

docs/itwin/list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ List all iTwins the calling user is a member of.
2222
Find iTwins with the exact number specified.
2323
**Type:** `string` **Required:** No
2424

25-
- **`-n, --display-name`**
25+
- **`-n, --name`**
2626
Find iTwins with the exact display name specified.
2727
**Type:** `string` **Required:** No
2828

@@ -63,7 +63,7 @@ itp itwin list --sub-class Project --status Active
6363
itp itwin list --sub-class Program --type Luxury --top 10
6464

6565
# Example 4: Searching by display name and including inactive iTwins
66-
itp itwin list --sub-class Asset --display-name "Solar Farm" --include-inactive true
66+
itp itwin list --sub-class Asset --name "Solar Farm" --include-inactive true
6767

6868
# Example 5: Filtering by parent iTwin ID and skipping the first 5 results
6969
itp itwin list --sub-class WorkPackage --parent-id b1a2c3d4-5678-90ab-cdef-1234567890ab --skip 5

docs/itwin/update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Update the specified iTwin. Only include properties you want to update.
88
The ID of the iTwin to be updated.
99
**Type:** `string` **Required:** Yes
1010

11-
- **`-n, --display-name`**
11+
- **`-n, --name`**
1212
The iTwin's display name.
1313
**Type:** `string **Required:** No
1414

@@ -37,7 +37,7 @@ Update the specified iTwin. Only include properties you want to update.
3737

3838
```bash
3939
# Example 1: Updating iTwin's display name
40-
itp itwin update --itwin-id b1a2c3d4-5678-90ab-cdef-1234567890ab --display-name "Updated Portfolio"
40+
itp itwin update --itwin-id b1a2c3d4-5678-90ab-cdef-1234567890ab --name "Updated Portfolio"
4141

4242
# Example 2: Changing geographic location and time zone
4343
itp itwin update --itwin-id b1a2c3d4-5678-90ab-cdef-1234567890ab --geographic-location "New York, NY" --iana-time-zone America/New_York

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ itp auth login
1919
An iTwin represents a **digital twin** that organizes models, repositories, and data sources.
2020

2121
```bash
22-
itp itwin create --class Thing --sub-class Asset --display-name "My First iTwin"
22+
itp itwin create --class Thing --sub-class Asset --name "My First iTwin"
2323
```
2424

2525
**Expected Outcome:** The command returns an *iTwin ID*, which you’ll use in the next steps.

docs/storage/file/create.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Create a new file in a specified folder in iTwin's storage.
88
The ID of the folder where the file will be created.
99
**Type:** `string` **Required:** Yes
1010

11-
- **`-n, --display-name`**
11+
- **`-n, --name`**
1212
The display name of the file.
1313
**Type:** `string` **Required:** Yes
1414

@@ -20,10 +20,10 @@ Create a new file in a specified folder in iTwin's storage.
2020

2121
```bash
2222
# Example 1: Creating a file with display name only
23-
itp storage file create --folder-id abc12345-6789-4321-abcd-9876543210ef --display-name design.dwg
23+
itp storage file create --folder-id abc12345-6789-4321-abcd-9876543210ef --name design.dwg
2424

2525
# Example 2: Creating a file with display name and description
26-
itp storage file create --folder-id abc12345-6789-4321-abcd-9876543210ef --display-name model.ifc --description "Model file for the building design"
26+
itp storage file create --folder-id abc12345-6789-4321-abcd-9876543210ef --name model.ifc --description "Model file for the building design"
2727
```
2828

2929
## API Reference

docs/storage/file/update.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Update the metadata of a file in an iTwin's storage, such as display name or des
88
The ID of the file to be updated.
99
**Type:** `string` **Required:** Yes
1010

11-
- **`-n, --display-name`**
11+
- **`-n, --name`**
1212
The new display name for the file.
1313
**Type:** `string` **Required:** No
1414

@@ -20,10 +20,10 @@ Update the metadata of a file in an iTwin's storage, such as display name or des
2020

2121
```bash
2222
# Example 1: Update file display name
23-
itp storage file update --file-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --display-name "Updated Design File"
23+
itp storage file update --file-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --name "Updated Design File"
2424

2525
# Example 2: Update file description and display name
26-
itp storage file update --file-id c9f2b8a5-345d-4cfa-b3e5-123456789abc --display-name "New Model File" --description "Updated model with new specifications"
26+
itp storage file update --file-id c9f2b8a5-345d-4cfa-b3e5-123456789abc --name "New Model File" --description "Updated model with new specifications"
2727
```
2828

2929
## API Reference

0 commit comments

Comments
 (0)