Skip to content

Commit 2c8c9fb

Browse files
ypcodeVesaJuvonen
authored andcommitted
Fix some bad ___location for 1st level actions (SharePoint#1661)
1 parent 54e1850 commit 2c8c9fb

File tree

1 file changed

+109
-109
lines changed

1 file changed

+109
-109
lines changed

docs/declarative-customization/site-design-json-schema.md

Lines changed: 109 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -198,115 +198,6 @@ Example:
198198
}
199199
```
200200

201-
### createSiteColumn
202-
203-
Defines a new site column that can then be associated to a list directly or using the addContentType action.
204-
205-
JSON value:
206-
207-
> [!NOTE]
208-
> When referencing the content type ID only one of the three references are required - ID, parentName, or parentId
209-
210-
- **fieldType** - The type of column to add. Supported values - like SPField - are Text, Note, Number, Boolean, User, and DateTime. For other data types refer to the addSPFieldXml script action.
211-
- **internalName** - The internal name of the site column.
212-
- **displayName** - The display name of the site column.
213-
- **isRequired** - True if this field is required to contain information; otherwise, false.
214-
- **group** - An optional attribute to designate the column group.
215-
- **enforceUnique** - An optional attribute that defaults to false. If true, then all values for this field must be unique.
216-
217-
Example:
218-
219-
```json
220-
{
221-
"verb": "createSiteColumn",
222-
"fieldType": "User",
223-
"internalName": "siteColumn4User",
224-
"displayName": "Project Owner",
225-
"isRequired": false
226-
}
227-
```
228-
229-
### addSiteColumn
230-
231-
Subaction to add a previously defined site column directly to a list or content type (exisiting or created through the site script).
232-
233-
> [!NOTE]
234-
> This action can be used to add created site columns to a list or content type.
235-
236-
JSON value:
237-
238-
- **internalName** - The internal name of the site column to add.
239-
240-
Example:
241-
242-
```json
243-
{
244-
"verb": "addSiteColumn",
245-
"internalName": "siteColumnUser"
246-
}
247-
```
248-
249-
### removeSiteColumn
250-
251-
Subaction to remove a site column from a list or content type.
252-
253-
JSON value:
254-
255-
- **internalName** - The internal name of the site column to remove.
256-
257-
Example:
258-
259-
```json
260-
{
261-
"verb": "removeSiteColumn",
262-
"internalName": "siteColumnUser"
263-
}
264-
```
265-
266-
### createContentType
267-
268-
Defines a new content type that can then be associated to a list using the addContentType action.
269-
270-
JSON value:
271-
272-
> [!NOTE]
273-
> When referencing the content type ID only one of the three references are required - ID, parentName, or parentId
274-
275-
- **name** - The name of the content type to create.
276-
- **description** - The optional description of the content type.
277-
- **parentName** - Name of the parent content type.
278-
- **parentId** - ID of the parent content type.
279-
- **id** - ID of the content type.
280-
- **hidden** - Specifies whether the content type is visible or hidden.
281-
- **subactions** - Specifies subactions to run on the content type. These are used to designate the site columns to add.
282-
283-
Example:
284-
285-
```json
286-
{
287-
"verb": "createContentType",
288-
"name": "Contoso Projects",
289-
"description": "custom list content type",
290-
"parentName": "Item",
291-
"hidden": false,
292-
"subactions":
293-
[
294-
{
295-
"verb": "addSiteColumn",
296-
"internalName": "siteColumn1Text"
297-
},
298-
{
299-
"verb": "addSiteColumn",
300-
"internalName": "siteColumn2Number"
301-
},
302-
{
303-
"verb": "addSiteColumn",
304-
"internalName": "siteColumn3Note"
305-
}
306-
]
307-
}
308-
```
309-
310201
### addContentType
311202

312203
Adds a content type to the list. Currently these are limited to the default content types included in the site template or ones defined in a script using the createContentType action.
@@ -405,6 +296,115 @@ Example: In this example we are formatting a number column as a data bar
405296
}
406297
```
407298

299+
300+
## createSiteColumn
301+
302+
Defines a new site column that can then be associated to a list directly or using the addContentType action.
303+
304+
JSON value:
305+
306+
- **fieldType** - The type of column to add. Supported values - like SPField - are Text, Note, Number, Boolean, User, and DateTime. For other data types refer to the addSPFieldXml script action.
307+
- **internalName** - The internal name of the site column.
308+
- **displayName** - The display name of the site column.
309+
- **isRequired** - True if this field is required to contain information; otherwise, false.
310+
- **group** - An optional attribute to designate the column group.
311+
- **enforceUnique** - An optional attribute that defaults to false. If true, then all values for this field must be unique.
312+
313+
Example:
314+
315+
```json
316+
{
317+
"verb": "createSiteColumn",
318+
"fieldType": "User",
319+
"internalName": "siteColumn4User",
320+
"displayName": "Project Owner",
321+
"isRequired": false
322+
}
323+
```
324+
325+
## createContentType
326+
327+
Defines a new content type that can then be associated to a list using the addContentType action.
328+
329+
JSON value:
330+
331+
> [!NOTE]
332+
> When referencing the content type ID only one of the three references are required - ID, parentName, or parentId
333+
334+
- **name** - The name of the content type to create.
335+
- **description** - The optional description of the content type.
336+
- **parentName** - Name of the parent content type.
337+
- **parentId** - ID of the parent content type.
338+
- **id** - ID of the content type.
339+
- **hidden** - Specifies whether the content type is visible or hidden.
340+
- **subactions** - Specifies subactions to run on the content type. These are used to designate the site columns to add.
341+
342+
Example:
343+
344+
```json
345+
{
346+
"verb": "createContentType",
347+
"name": "Contoso Projects",
348+
"description": "custom list content type",
349+
"parentName": "Item",
350+
"hidden": false,
351+
"subactions":
352+
[
353+
{
354+
"verb": "addSiteColumn",
355+
"internalName": "siteColumn1Text"
356+
},
357+
{
358+
"verb": "addSiteColumn",
359+
"internalName": "siteColumn2Number"
360+
},
361+
{
362+
"verb": "addSiteColumn",
363+
"internalName": "siteColumn3Note"
364+
}
365+
]
366+
}
367+
```
368+
369+
### addSiteColumn
370+
371+
Subaction to add a previously defined site column directly to a list or content type (exisiting or created through the site script).
372+
373+
> [!NOTE]
374+
> This action can be used to add created site columns to a list or content type.
375+
376+
JSON value:
377+
378+
- **internalName** - The internal name of the site column to add.
379+
380+
Example:
381+
382+
```json
383+
{
384+
"verb": "addSiteColumn",
385+
"internalName": "siteColumnUser"
386+
}
387+
```
388+
389+
### removeSiteColumn
390+
391+
Subaction to remove a site column from a list or content type.
392+
393+
JSON value:
394+
395+
- **internalName** - The internal name of the site column to remove.
396+
397+
Example:
398+
399+
```json
400+
{
401+
"verb": "removeSiteColumn",
402+
"internalName": "siteColumnUser"
403+
}
404+
```
405+
406+
407+
408408
## Add a navigation link
409409

410410
Use the **addNavLink** verb to add a new navigation link to the site.

0 commit comments

Comments
 (0)