Skip to content

Commit 0dd788f

Browse files
authored
Update site-design-rest-api.md
1 parent 8b2b02d commit 0dd788f

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/declarative-customization/site-design-rest-api.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,8 @@ Gets the site script syntax for a specific SharePoint site.
170170
| IncludeTheme | (Optional) True if custom theme will be extracted; otherwise false. |
171171
| IncludeLinksToExportedItems | (Optional) True if navigation links will be extracted; otherwise false. In order to export navigation links pointing to lists, the list needs to be included in the request as well. |
172172

173-
>**Note:** At least one **include** parameter must be provided when using this API, otherwise request fails.
173+
> [!NOTE]
174+
> At least one **include** parameter must be provided when using this API, otherwise request fails.
174175
175176
### Examples
176177

@@ -195,7 +196,8 @@ RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScri
195196

196197
Here is an example of the JSON returned after calling **GetSiteScriptFromWeb**.
197198

198-
>**Note:** The response object shown here might be shortened for readability.
199+
> [!NOTE]
200+
> The response object shown here might be shortened for readability.
199201
200202
```json
201203
{
@@ -265,7 +267,7 @@ Here is an example of the JSON returned after calling **GetSiteScriptFromWeb**.
265267

266268
## GetSiteScriptFromList
267269

268-
Gets the site script syntax for a specific list
270+
Gets the site script syntax for a specific list.
269271

270272
### Parameters
271273

@@ -435,7 +437,7 @@ Creates a new site design available to users when they create a new site from th
435437
|SiteScriptIds | An array of one or more site scripts. Each is identified by an ID. The scripts will run in the order listed. |
436438
|Description | (Optional) The display description of site design. |
437439
|PreviewImageUrl | (Optional) The URL of a preview image. If none is specified, SharePoint uses a generic image. |
438-
|PreviewImageAltText | (Optional) The alt text description of the image for accessibility. |
440+
|PreviewImageAltText | (Optional) The alt text description of the preview image for accessibility. |
439441
|IsDefault | (Optional) **True** if the site design is applied as the default site design; otherwise, **false**. For more information see [Customize a default site design](customize-default-site-design.md). |
440442

441443
### Examples
@@ -518,7 +520,7 @@ Gets a list of information about existing site designs.
518520

519521
### Parameters
520522

521-
None
523+
None.
522524

523525
### Examples
524526

@@ -618,7 +620,7 @@ Updates a site design with new values. In the REST call, all parameters are opti
618620
|SiteScripts | (Optional) A new array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. |
619621
|Description | (Optional) The new display description of the updated site design. |
620622
|PreviewImageUrl | (Optional) The new URL of a preview image. |
621-
|PreviewImageAltText | (Optional) The new alt text description of the image for accessibility. |
623+
|PreviewImageAltText | (Optional) The new alt text description of the preview image for accessibility. |
622624
|IsDefault | (Optional) **True** if the site design is applied as the default site design; otherwise, **false**. For more information see [Customize a default site design](customize-default-site-design.md). |
623625

624626
### Examples
@@ -739,7 +741,7 @@ Grants access to a site design for one or more principals.
739741

740742
### Examples
741743

742-
Here's an example of granting view rights to a site design for Nestor and Patti (fictional users at Contoso.)
744+
Here's an example of granting view rights to a site design for Nestor and Patti (fictional users at Contoso).
743745

744746
```javascript
745747
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GrantSiteDesignRights", {
@@ -762,12 +764,12 @@ Revokes access from a site design for one or more principals.
762764

763765
### Examples
764766

765-
Here's an example of revoking view rights from a site design for Patti (fictional user at Contoso.)
767+
Here's an example of revoking view rights from a site design for Patti (fictional user at Contoso).
766768

767769
```javascript
768770
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.RevokeSiteDesignRights",
769771
{id:"5d4756e9-e1f5-42f7-afa7-5fa5aac170aa",
770-
principalNames:["[email protected].com"] });
772+
principalNames:["[email protected].com"] });
771773
```
772774

773775
## See also

0 commit comments

Comments
 (0)