Skip to content

Improves examples requests and responses #9771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FaithOmbongi merged 1 commit into from
Dec 30, 2025
Merged

Improves examples requests and responses #9771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions api-reference/beta/api/workbook-list-worksheets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,10 @@ Content-type: application/json
{
"value": [
{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 0,
"name": "Sheet1",
"visibility": "Visible"
}
]
}
Expand Down
4 changes: 2 additions & 2 deletions api-reference/beta/api/worksheet-delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ DELETE /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}

## Response

If successful, this method returns `200 OK` response code. It doesn't return anything in the response body.
If successful, this method returns `204 No Content` response code. It doesn't return anything in the response body.

## Example
Here is an example of how to call this API.
Expand Down Expand Up @@ -89,7 +89,7 @@ The following example shows the response.
"blockType": "response"
} -->
```http
HTTP/1.1 200 OK
HTTP/1.1 204 No Content
```

<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
Expand Down
8 changes: 4 additions & 4 deletions api-reference/beta/api/worksheet-get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,10 @@ HTTP/1.1 200 OK
Content-type: application/json

{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 1,
"name": "Sheet1",
"visibility": "Visible"
}
```

Expand Down
8 changes: 4 additions & 4 deletions api-reference/beta/api/worksheet-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,10 @@ Content-type: application/json
{
"value": [
{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 0,
"name": "Sheet1",
"visibility": "Visible"
}
]
}
Expand Down
20 changes: 10 additions & 10 deletions api-reference/beta/api/worksheet-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ In the request body, supply the values for relevant fields that should be update

| Property | Type |Description|
|:---------------|:--------|:----------|
|name|string|The display name of the worksheet.|
|position|int|The zero-based position of the worksheet within the workbook.|
|visibility|string|The Visibility of the worksheet. The possible values are: `Visible`, `Hidden`, `VeryHidden`.|
|name|string|The display name of the worksheet. Optional.|
|position|int|The zero-based position of the worksheet within the workbook. Optional.|
|visibility|string|The Visibility of the worksheet. Optional. The possible values are: `Visible`, `Hidden`, `VeryHidden`.|

## Response

Expand All @@ -62,9 +62,9 @@ PATCH https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{
Content-type: application/json

{
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"position": 0,
"name": "Sheet2",
"visibility": "Hidden"
}
```

Expand Down Expand Up @@ -106,10 +106,10 @@ HTTP/1.1 200 OK
Content-type: application/json

{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 0,
"name": "Sheet2",
"visibility": "Hidden"
}
```

Expand Down
14 changes: 7 additions & 7 deletions api-reference/beta/api/worksheetcollection-add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ In the request body, provide a JSON object with the following parameters.

## Response

If successful, this method returns `200 OK` response code and [workbookWorksheet](../resources/workbookworksheet.md) object in the response body.
If successful, this method returns `201 Created` response code and [workbookWorksheet](../resources/workbookworksheet.md) object in the response body.

## Examples

Expand All @@ -63,7 +63,7 @@ POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/ad
Content-type: application/json

{
"name": "name-value"
"name": "Sheet1"
}
```

Expand Down Expand Up @@ -103,14 +103,14 @@ The following example shows the response.
"@odata.type": "microsoft.graph.workbookWorksheet"
} -->
```http
HTTP/1.1 200 OK
HTTP/1.1 201 Created
Content-type: application/json

{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 1,
"name": "Sheet1",
"visibility": "Visible"
}
```

Expand Down
8 changes: 4 additions & 4 deletions api-reference/v1.0/api/workbook-list-worksheets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ Content-type: application/json
{
"value": [
{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 0,
"name": "Sheet1",
"visibility": "Visible"
}
]
}
Expand Down
4 changes: 2 additions & 2 deletions api-reference/v1.0/api/worksheet-delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ DELETE /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}

## Response

If successful, this method returns `200 OK` response code. It doesn't return anything in the response body.
If successful, this method returns `204 No Content` response code. It doesn't return anything in the response body.

## Example
Here is an example of how to call this API.
Expand Down Expand Up @@ -88,7 +88,7 @@ The following example shows the response.
"truncated": true
} -->
```http
HTTP/1.1 200 OK
HTTP/1.1 204 No Content
```

<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
Expand Down
8 changes: 4 additions & 4 deletions api-reference/v1.0/api/worksheet-get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@ HTTP/1.1 200 OK
Content-type: application/json

{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 1,
"name": "Sheet1",
"visibility": "Visible"
}
```

Expand Down
8 changes: 4 additions & 4 deletions api-reference/v1.0/api/worksheet-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ Content-type: application/json
{
"value": [
{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 0,
"name": "Sheet1",
"visibility": "Visible"
}
]
}
Expand Down
20 changes: 10 additions & 10 deletions api-reference/v1.0/api/worksheet-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ In the request body, supply the values for relevant fields that should be update

| Property | Type |Description|
|:---------------|:--------|:----------|
|name|string|The display name of the worksheet.|
|position|int|The zero-based position of the worksheet within the workbook.|
|visibility|string|The Visibility of the worksheet. The possible values are: `Visible`, `Hidden`, `VeryHidden`.|
|name|string|The display name of the worksheet. Optional.|
|position|int|The zero-based position of the worksheet within the workbook. Optional.|
|visibility|string|The Visibility of the worksheet. Optional. The possible values are: `Visible`, `Hidden`, `VeryHidden`.|

## Response

Expand All @@ -62,9 +62,9 @@ PATCH https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/worksheets/{
Content-type: application/json
{
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"position": 0,
"name": "Sheet2",
"visibility": "Hidden"
}
```

Expand Down Expand Up @@ -106,10 +106,10 @@ HTTP/1.1 200 OK
Content-type: application/json
{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 0,
"name": "Sheet2",
"visibility": "Hidden"
}
```

Expand Down
12 changes: 6 additions & 6 deletions api-reference/v1.0/api/worksheetcollection-add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/worksheets/ad
Content-type: application/json

{
"name": "name-value"
"name": "Sheet1"
}
```

Expand Down Expand Up @@ -101,14 +101,14 @@ The following example shows the response.
"@odata.type": "microsoft.graph.workbookWorksheet"
} -->
```http
HTTP/1.1 200 OK
HTTP/1.1 201 Created
Content-type: application/json

{
"id": "id-value",
"position": 99,
"name": "name-value",
"visibility": "visibility-value"
"id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
"position": 1,
"name": "Sheet1",
"visibility": "Visible"
}
```

Expand Down
Loading