Skip to content

Commit 8acdc8c

Browse files
authored
Apply suggestions from code review
Co-authored-by: MSFT-Andrea <v-andreadr@microsoft.com>
1 parent 55a3bda commit 8acdc8c

11 files changed

Lines changed: 37 additions & 31 deletions

api-reference/beta/api/teamworksection-delete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ DELETE /users/{user-id}/teamwork/sections/{teamworkSection-id}
3737
| Header | Value |
3838
|:-------|:------|
3939
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts). |
40-
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation from [listing sections](userteamwork-list-sections.md), or equivalently the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
40+
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation returned when you [list sections](userteamwork-list-sections.md), or the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
4141

4242
## Request body
4343

api-reference/beta/api/teamworksection-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ This method doesn't support [OData query parameters](/graph/query-parameters) to
4141
| Header | Value |
4242
|:-------|:------|
4343
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts). |
44-
| If-None-Match | The value of the **@microsoft.graph.sectionsVersion** annotation from [listing sections](userteamwork-list-sections.md), or equivalently the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). If the section hierarchy didn't change, this header causes a `304 Not Modified` response. Optional. |
44+
| If-None-Match | The value of the **@microsoft.graph.sectionsVersion** annotation returned when you [list sections](userteamwork-list-sections.md), or the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). If the section hierarchy didn't change, this header returns a `304 Not Modified` response code. Optional. |
4545

4646
## Request body
4747

api-reference/beta/api/teamworksection-post-items.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ POST /users/{user-id}/teamwork/sections/{teamworkSection-id}/items
3838
|:-------|:------|
3939
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts). |
4040
| Content-Type | application/json. Required. |
41-
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation from [listing sections](userteamwork-list-sections.md), or equivalently the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
41+
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation returned when you [list sections](userteamwork-list-sections.md), or the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
4242

4343
## Request body
4444

@@ -57,15 +57,15 @@ If successful, this method returns a `201 Created` response code and a [teamwork
5757
> [!NOTE]
5858
> The response includes an updated **@odata.etag** value. Use this value as the `If-Match` header for any subsequent mutation operations.
5959
60-
The following errors can occur:
60+
This method can also return the following errors.
6161

6262
| Scenario | HTTP code | Error code | Message |
6363
|:---------|:----------|:-----------|:--------|
6464
| Item already exists in this section | `409 Conflict` | `conflict` | This item is already in this section. |
6565
| Item already exists in another section | `409 Conflict` | `conflict` | This item is already associated with another section. Use the [move](teamworksectionitem-move.md) API to relocate it. |
66-
| Maximum items per section reached | `400 Bad Request` | `badRequest` | The maximum number of items in this section has been reached. |
67-
| Invalid item ID | `400 Bad Request` | `badRequest` | The specified item ID is not valid. Provide a valid chat, channel, meeting, or community ID. |
68-
| ETag version mismatch | `412 Precondition Failed` | `preconditionFailed` | The resource has been modified since it was last read. Read the latest version and retry. |
66+
| Maximum items per section reached | `400 Bad Request` | `badRequest` | The maximum number of items in this section is reached. |
67+
| Invalid item ID | `400 Bad Request` | `badRequest` | The specified item ID isn't valid. Provide a valid chat, channel, meeting, or community ID. |
68+
| ETag version mismatch | `412 Precondition Failed` | `preconditionFailed` | The resource was modified after it was last read. Read the latest version and retry. |
6969

7070
## Examples
7171

api-reference/beta/api/teamworksection-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PATCH /users/{user-id}/teamwork/sections/{teamworkSection-id}
3838
|:-------|:------|
3939
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts). |
4040
| Content-Type | application/json. Required. |
41-
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation from [listing sections](userteamwork-list-sections.md), or equivalently the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
41+
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation returned when you [list sections](userteamwork-list-sections.md), or the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
4242

4343
## Request body
4444

api-reference/beta/api/teamworksectionitem-delete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Remove teamworkSectionItem"
3-
description: "Remove an item from a section in a user's teamwork. This API doesn't delete the underlying chat, channel, meeting, or community; it only removes the item from the section."
3+
description: "Remove an item from a section in a user's teamwork."
44
author: "jsinghmokha"
55
ms.localizationpriority: medium
66
ms.subservice: "teams"
@@ -37,7 +37,7 @@ DELETE /users/{user-id}/teamwork/sections/{teamworkSection-id}/items/{teamworkSe
3737
| Header | Value |
3838
|:-------|:------|
3939
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts). |
40-
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation from [listing sections](userteamwork-list-sections.md), or equivalently the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
40+
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation returned when you [list sections](userteamwork-list-sections.md), or the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
4141

4242
## Request body
4343

api-reference/beta/api/teamworksectionitem-move.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "teamworkSectionItem: move"
3-
description: "Move an item from one section to another in a user's teamwork. Each item can belong to only one section at a time. This action removes the item from its current section and adds it to the target section."
3+
description: "Move an item from one section to another in a user's teamwork."
44
author: "jsinghmokha"
55
ms.localizationpriority: medium
66
ms.subservice: "teams"
@@ -38,7 +38,7 @@ POST /users/{user-id}/teamwork/sections/{teamworkSection-id}/items/{teamworkSect
3838
|:-------|:------|
3939
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts). |
4040
| Content-Type | application/json. Required. |
41-
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation from [listing sections](userteamwork-list-sections.md), or equivalently the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
41+
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation returned when you [list sections](userteamwork-list-sections.md), or the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
4242

4343
## Request body
4444

api-reference/beta/api/userteamwork-list-sections.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ Don't supply a request body for this method.
5050

5151
If successful, this method returns a `200 OK` response code and a collection of [teamworkSection](../resources/teamworksection.md) objects in the response body.
5252

53-
The response includes the following OData instance annotations on the collection:
53+
The response includes the following OData instance annotations on the collection.
5454

5555
| Annotation | Type | Description |
5656
|:-----------|:-----|:------------|
57-
| @microsoft.graph.sectionsOrder | String collection | An ordered array of section IDs representing the user's preferred section order. |
58-
| @microsoft.graph.sectionsVersion | String | The current section hierarchy version. Use this value as the `If-Match` header for optimistic concurrency control on mutation operations (create, update, delete sections, and add, remove, or move items). |
57+
| @microsoft.graph.sectionsOrder | String collection | An ordered array of section IDs that represent the user's preferred section order. |
58+
| @microsoft.graph.sectionsVersion | String | The current section hierarchy version. Use this value as the `If-Match` header for optimistic concurrency control on mutation operations (create, update, or delete sections, and add, remove, or move items). |
5959

6060
## Examples
6161

api-reference/beta/api/userteamwork-post-sections.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ POST /users/{user-id}/teamwork/sections
3838
|:-------|:------|
3939
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts). |
4040
| Content-Type | application/json. Required. |
41-
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation from [listing sections](userteamwork-list-sections.md), or equivalently the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
41+
| If-Match | The value of the **@microsoft.graph.sectionsVersion** annotation returned when you [list sections](userteamwork-list-sections.md), or the **@odata.etag** value from any previously retrieved [section](../resources/teamworksection.md). Required for optimistic concurrency control. |
4242

4343
## Request body
4444

api-reference/beta/resources/teamworksection.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,7 @@ Represents a section in a user's Microsoft Teams chat list that organizes chats,
2525
| [Get](../api/teamworksection-get.md) | [teamworkSection](teamworksection.md) | Read the properties of a [section](../resources/teamworksection.md) in a user's [teamwork](../resources/userteamwork.md). |
2626
| [Update](../api/teamworksection-update.md) | [teamworkSection](teamworksection.md) | Update the properties of a [section](../resources/teamworksection.md) in a user's [teamwork](../resources/userteamwork.md). |
2727
| [Delete](../api/teamworksection-delete.md) | None | Delete a user-defined [section](../resources/teamworksection.md) from a user's [teamwork](../resources/userteamwork.md). |
28-
| [List items](../api/teamworksection-list-items.md) | [teamworkSectionItem](teamworksectionitem.md) collection | Get the list of [items](../resources/teamworksectionitem.md) in a [section](../resources/teamworksection.md). |
29-
| [Add item](../api/teamworksection-post-items.md) | [teamworkSectionItem](teamworksectionitem.md) | Add an [item](../resources/teamworksectionitem.md) to a [section](../resources/teamworksection.md). |
30-
| [Remove item](../api/teamworksectionitem-delete.md) | None | Remove an [item](../resources/teamworksectionitem.md) from a [section](../resources/teamworksection.md). |
31-
| [Move item](../api/teamworksectionitem-move.md) | [teamworkSectionItem](teamworksectionitem.md) | Move an [item](../resources/teamworksectionitem.md) from one section to another. |
28+
| [List items](../api/teamworksection-list-items.md) | [teamworkSectionItem](teamworksectionitem.md) collection | Get the list of [items](../resources/teamworksectionitem.md) in a [section](../resources/teamworksection.md) of a user's [teamwork](../resources/userteamwork.md). |
3229

3330
## Properties
3431

@@ -65,6 +62,15 @@ Represents a section in a user's Microsoft Teams chat list that organizes chats,
6562
> [!NOTE]
6663
> The valid sort types for system-defined sections depend on the specific section. For example, the *Teams* and *Channels* sections support `nameAlphabetical`, but the *RecentChats* and *MutedChats* sections support only `mostRecent` and `unreadThenMostRecent`. When the property **isHierarchicalViewEnabled** is set to `true` for a *Teams* and *Channels* section, only `nameAlphabetical` is valid. Setting an unsupported sort type returns a `400 Bad Request` error.
6764
65+
### Instance attributes
66+
67+
Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.
68+
69+
| Property name | Type | Description |
70+
|:-----------|:-----|:------------|
71+
| @microsoft.graph.sectionsOrder | String collection | An ordered array of section IDs that represent the user's preferred section order. |
72+
| @microsoft.graph.sectionsVersion | String | The current section hierarchy version. Use this value as the `If-Match` header for optimistic concurrency control on mutation operations (create, update, or delete sections, and add, remove, or move items). |
73+
6874
## Relationships
6975

7076
| Relationship | Type | Description |

api-reference/beta/resources/teamworksectionitem.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Represents an item, such as a chat, channel, meeting, or community, that is orga
2020

2121
| Method | Return type | Description |
2222
|:-------|:------------|:------------|
23-
| [List](../api/teamworksection-list-items.md) | [teamworkSectionItem](teamworksectionitem.md) collection | Get the list of items in a [section](../resources/teamworksection.md). |
24-
| [Add](../api/teamworksection-post-items.md) | [teamworkSectionItem](teamworksectionitem.md) | Add an item to a [section](../resources/teamworksection.md). |
25-
| [Remove](../api/teamworksectionitem-delete.md) | None | Remove an item from a [section](../resources/teamworksection.md). |
26-
| [Move](../api/teamworksectionitem-move.md) | [teamworkSectionItem](teamworksectionitem.md) | Move an item from one section to another. |
23+
| [List](../api/teamworksection-list-items.md) | [teamworkSectionItem](teamworksectionitem.md) collection | Get the list of [items](../resources/teamworksectionitem.md) in a [section](../resources/teamworksection.md) of a user's [teamwork](../resources/userteamwork.md). |
24+
| [Add](../api/teamworksection-post-items.md) | [teamworkSectionItem](teamworksectionitem.md) | Add an [item](../resources/teamworksectionitem.md), such as a chat, channel, meeting, or community, to a [section](../resources/teamworksection.md) in a user's [teamwork](../resources/userteamwork.md). |
25+
| [Remove](../api/teamworksectionitem-delete.md) | None | Remove an [item](../resources/teamworksectionitem.md) from a [section](../resources/teamworksection.md) in a user's [teamwork](../resources/userteamwork.md). |
26+
| [Move](../api/teamworksectionitem-move.md) | [teamworkSectionItem](teamworksectionitem.md) | Move an [item](../resources/teamworksectionitem.md) from one [section](../resources/teamworksection.md) to another in a user's [teamwork](../resources/userteamwork.md). |
2727

2828
## Properties
2929

0 commit comments

Comments
 (0)