Skip to content

Commit

Permalink
Update planner roster docs response
Browse files Browse the repository at this point in the history
  • Loading branch information
nanddeepn committed Mar 14, 2024
1 parent 443bfd8 commit 897538d
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/docs/cmd/planner/plan/plan-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
Adds a Microsoft Planner plan with a Roster by id.

```sh
m365 planner plan add --title 'My Planner Plan' --rosterId 'tYqYlNd6eECmsNhN_fcq85cAGAnd'
m365 planner plan add --title 'My Planner Plan' --rosterId '29dab52a-9c2b-4abe-b467-65f64016c28a'
```

Adds a Microsoft Planner plan with with a Group by name and share it with the given users.
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/cmd/planner/roster/roster-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ m365 planner roster add

```json
{
"id": "e6fmvM_yi0OJgvmepE5uj5cAE6qX",
"id": "29dab52a-9c2b-4abe-b467-65f64016c28a",
"assignedSensitivityLabel": null
}
```
Expand All @@ -61,15 +61,15 @@ m365 planner roster add

```text
assignedSensitivityLabel: null
id : e6fmvM_yi0OJgvmepE5uj5cAE6qX
id : 29dab52a-9c2b-4abe-b467-65f64016c28a
```

</TabItem>
<TabItem value="CSV">

```csv
id,assignedSensitivityLabel
e6fmvM_yi0OJgvmepE5uj5cAE6qX,
29dab52a-9c2b-4abe-b467-65f64016c28a,
```

</TabItem>
Expand All @@ -80,11 +80,11 @@ m365 planner roster add

Date: 7/2/2023

## e6fmvM_yi0OJgvmepE5uj5cAE6qX
## 29dab52a-9c2b-4abe-b467-65f64016c28a

Property | Value
---------|-------
id | e6fmvM_yi0OJgvmepE5uj5cAE6qX
id | 29dab52a-9c2b-4abe-b467-65f64016c28a
assignedSensitivityLabel | null
```

Expand Down
14 changes: 7 additions & 7 deletions docs/docs/cmd/planner/roster/roster-get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This command is based on an API that is currently in preview and is subject to c
Gets information about a specific Planner Roster.

```sh
m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd
m365 planner roster get --id 29dab52a-9c2b-4abe-b467-65f64016c28a
```

## Response
Expand All @@ -44,7 +44,7 @@ m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd

```json
{
"id": "tYqYlNd6eECmsNhN_fcq85cAGAnd",
"id": "29dab52a-9c2b-4abe-b467-65f64016c28a",
"assignedSensitivityLabel": null
}
```
Expand All @@ -54,30 +54,30 @@ m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd

```text
assignedSensitivityLabel: null
id : tYqYlNd6eECmsNhN_fcq85cAGAnd
id : 29dab52a-9c2b-4abe-b467-65f64016c28a
```

</TabItem>
<TabItem value="CSV">

```csv
id,assignedSensitivityLabel
tYqYlNd6eECmsNhN_fcq85cAGAnd,
29dab52a-9c2b-4abe-b467-65f64016c28a,
```

</TabItem>
<TabItem value="Markdown">

```md
# planner roster get --id "tYqYlNd6eECmsNhN_fcq85cAGAnd"
# planner roster get --id "29dab52a-9c2b-4abe-b467-65f64016c28a"

Date: 1/30/2023

## undefined (tYqYlNd6eECmsNhN_fcq85cAGAnd)
## undefined (29dab52a-9c2b-4abe-b467-65f64016c28a)

Property | Value
---------|-------
id | tYqYlNd6eECmsNhN_fcq85cAGAnd
id | 29dab52a-9c2b-4abe-b467-65f64016c28a
assignedSensitivityLabel | null
```

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/cmd/planner/roster/roster-member-add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ This command is based on an API that is currently in preview and is subject to c
Adds a specific user by user name as member of the Planner Roster.

```sh
m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName [email protected]
m365 planner roster member add --rosterId 29dab52a-9c2b-4abe-b467-65f64016c28a --userName [email protected]
```

Adds a specific user by ID as member of the Planner Roster.

```sh
m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
m365 planner roster member add --rosterId 29dab52a-9c2b-4abe-b467-65f64016c28a --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
```

## Response
Expand Down Expand Up @@ -85,7 +85,7 @@ m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId
<TabItem value="Markdown">

```md
# planner roster member add --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
# planner roster member add --rosterId "29dab52a-9c2b-4abe-b467-65f64016c28a" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"

Date: 6/2/2023

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/cmd/planner/roster/roster-member-get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ This command is based on an API that is currently in preview and is subject to c
Gets a specific user by user name as member of the Planner Roster.

```sh
m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName [email protected]
m365 planner roster member get --rosterId 29dab52a-9c2b-4abe-b467-65f64016c28a --userName [email protected]
```

Gets a specific user by ID as member of the Planner Roster.

```sh
m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
m365 planner roster member get --rosterId 29dab52a-9c2b-4abe-b467-65f64016c28a --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
```

## Response
Expand Down Expand Up @@ -85,7 +85,7 @@ m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId
<TabItem value="Markdown">

```md
# planner roster member get --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
# planner roster member get --rosterId "29dab52a-9c2b-4abe-b467-65f64016c28a" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"

Date: 18/2/2023

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cmd/planner/roster/roster-member-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This command is based on an API that is currently in preview and is subject to c
Lists members of the specified Microsoft Planner Roster.

```sh
m365 planner roster member list --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd
m365 planner roster member list --rosterId 29dab52a-9c2b-4abe-b467-65f64016c28a
```

## Response
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/cmd/planner/roster/roster-member-remove.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ The Planner Roster will be deleted when it doesn't have any users remaining in t
Remove a Roster member by its Azure AD ID

```sh
m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId 126878e5-d8f9-4db2-951d-d25486488d38
m365 planner roster member remove --rosterId 29dab52a-9c2b-4abe-b467-65f64016c28a --userId 126878e5-d8f9-4db2-951d-d25486488d38
```

Remove a Roster member by its UPN

```sh
m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName [email protected]
m365 planner roster member remove --rosterId 29dab52a-9c2b-4abe-b467-65f64016c28a --userName [email protected]
```

## Response
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/cmd/planner/roster/roster-remove.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ This command is based on an API that is currently in preview and is subject to c
Removes a Planner Roster

```sh
m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd
m365 planner roster remove --id 29dab52a-9c2b-4abe-b467-65f64016c28a
```

Removes a Planner Roster without confirmation prompt

```sh
m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd --force
m365 planner roster remove --id 29dab52a-9c2b-4abe-b467-65f64016c28a --force
```

## Response
Expand Down
2 changes: 1 addition & 1 deletion src/m365/planner/commands/plan/plan-set.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ describe(commands.PLAN_SET, () => {
const title = 'Plan name';
const ownerGroupName = 'Group name';
const ownerGroupId = '00000000-0000-0000-0000-000000000002';
const rosterId = 'tYqYlNd6eECmsNhN_fcq85cAGAnd';
const rosterId = '29dab52a-9c2b-4abe-b467-65f64016c28a';
const newTitle = 'New Title';
const user = '[email protected]';
const userId = '00000000-0000-0000-0000-000000000000';
Expand Down
2 changes: 1 addition & 1 deletion src/m365/planner/commands/roster/roster-add.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import command from './roster-add.js';

describe(commands.ROSTER_ADD, () => {
const rosterResponse = {
id: "e6fmvM_yi0OJgvmepE5uj5cAE6qX",
id: "29dab52a-9c2b-4abe-b467-65f64016c28a",
assignedSensitivityLabel: null
};

Expand Down
2 changes: 1 addition & 1 deletion src/m365/planner/commands/roster/roster-get.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import commands from '../../commands.js';
import command from './roster-get.js';

describe(commands.ROSTER_GET, () => {
const id = 'tYqYlNd6eECmsNhN_fcq85cAGAnd';
const id = '29dab52a-9c2b-4abe-b467-65f64016c28a';
const rosterGetResponse = {
"id": id,
"assignedSensitivityLabel": null
Expand Down

0 comments on commit 897538d

Please sign in to comment.