Skip to content

Commit c7fc236

Browse files
megan-basekitmegan-basekit
committed
added missing site update commands
1 parent e0dd5be commit c7fc236

File tree

1 file changed

+263
-0
lines changed

1 file changed

+263
-0
lines changed

‎service/sites.json‎

Lines changed: 263 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,269 @@
4242
}
4343
},
4444

45+
"UpdateSite": {
46+
"httpMethod": "PUT",
47+
"parameters": {
48+
"activationStatus": {
49+
"description": "Optionally set for sites on brands that use the brand activationURL.",
50+
"enum": [
51+
"active",
52+
"inactive"
53+
],
54+
"location": "json",
55+
"required": false,
56+
"type": "string"
57+
},
58+
"databaseReadUser": {
59+
"description": "The site’s database read username (internal-developer only)",
60+
"location": "json",
61+
"required": false,
62+
"type": "string"
63+
},
64+
"databaseSchema": {
65+
"description": "The name of the site’s database (internal-developer only)",
66+
"location": "json",
67+
"required": false,
68+
"type": "string"
69+
},
70+
"databaseWriteUser": {
71+
"description": "The site’s database write username (internal-developer only)",
72+
"location": "json",
73+
"required": false,
74+
"type": "string"
75+
},
76+
"enabled": {
77+
"description": "Boolean value if the site is enabled or disabled",
78+
"enum": [
79+
"0",
80+
"1"
81+
],
82+
"location": "json",
83+
"required": false,
84+
"type": "integer"
85+
},
86+
"live": {
87+
"description": "Boolean value if the site is online or offline.",
88+
"enum": [
89+
"0",
90+
"1"
91+
],
92+
"location": "json",
93+
"required": false,
94+
"type": "integer"
95+
},
96+
"templateRef": {
97+
"description": "Ref of the template to be used on the site",
98+
"location": "json",
99+
"required": false,
100+
"type": "integer"
101+
},
102+
"mobileSiteRef": {
103+
"description": "Site ref for mobile version of the site.",
104+
"location": "json",
105+
"required": false,
106+
"type": "integer"
107+
},
108+
"mobileThemeRef": {
109+
"description": "Mobile theme reference if a mobile site.",
110+
"location": "json",
111+
"required": false,
112+
"type": "integer"
113+
},
114+
"primaryUrlRef": {
115+
"description": "The urlRef must be associated with the site.",
116+
"location": "json",
117+
"required": false,
118+
"type": "integer"
119+
},
120+
"privateWidgets": {
121+
"description": "Boolean value if the User should have privateWidgets or not. 0 or 1 allowed",
122+
"location": "json",
123+
"required": false,
124+
"type": "integer"
125+
},
126+
"redirectToPrimary": {
127+
"description": "Boolean value if the mobile site is offline but you want to redirect back to desktop",
128+
"enum": [
129+
"0",
130+
"1"
131+
],
132+
"location": "json",
133+
"required": false,
134+
"type": "integer"
135+
},
136+
"siteRef": {
137+
"description": "Site reference to be updated.",
138+
"location": "uri",
139+
"required": true,
140+
"type": "integer"
141+
},
142+
"thumbUrl": {
143+
"description": "thumbUrl location",
144+
"location": "json",
145+
"required": false,
146+
"type": "string"
147+
},
148+
"userRef": {
149+
"description": "User reference of the owner. This may be used to transfer the site to a different user. The new user must be accessible in the caller’s scope.",
150+
"location": "json",
151+
"required": false,
152+
"type": "integer"
153+
}
154+
},
155+
"summary": "Update Site details. Only updates provided fields.",
156+
"uri": "/sites/{siteRef}"
157+
},
158+
159+
"UpdateSitePage": {
160+
"httpMethod": "PUT",
161+
"parameters": {
162+
"bodyscript": {
163+
"description": "Body Script",
164+
"location": "json",
165+
"required": false,
166+
"type": "string"
167+
},
168+
"colorSwatchRef": {
169+
"description": "Color Swatch",
170+
"location": "json",
171+
"required": false,
172+
"type": "integer"
173+
},
174+
"description": {
175+
"description": "Description of the page",
176+
"location": "json",
177+
"required": false,
178+
"type": "string"
179+
},
180+
"displayOrder": {
181+
"description": "The order in which to display the page",
182+
"location": "json",
183+
"required": false,
184+
"type": "integer"
185+
},
186+
"folder": {
187+
"description": "Ref of the folder type page to move the page into. Provide 0 if you want to move the page to root level.",
188+
"location": "json",
189+
"required": false,
190+
"type": "integer"
191+
},
192+
"fontSwatchRef": {
193+
"description": "Font Swatch",
194+
"location": "json",
195+
"required": false,
196+
"type": "integer"
197+
},
198+
"headscript": {
199+
"description": "Head Script",
200+
"location": "json",
201+
"required": false,
202+
"type": "string"
203+
},
204+
"keywords": {
205+
"description": "Keywords of the page, separated by a comma",
206+
"location": "json",
207+
"required": false,
208+
"type": "string"
209+
},
210+
"pageRef": {
211+
"description": "Page reference to be updated.",
212+
"location": "uri",
213+
"required": true,
214+
"type": "integer"
215+
},
216+
"pageUrl": {
217+
"description": "Page URL",
218+
"location": "json",
219+
"required": false,
220+
"type": "string"
221+
},
222+
"siteRef": {
223+
"description": "Site reference.",
224+
"location": "uri",
225+
"required": true,
226+
"type": "integer"
227+
},
228+
"status": {
229+
"default": "active",
230+
"description": "Controls the page visibility when publishing a site",
231+
"enum": [
232+
"active",
233+
"draft",
234+
"inactive"
235+
],
236+
"location": "json",
237+
"required": true,
238+
"type": "string"
239+
},
240+
"themeRef": {
241+
"description": "Theme",
242+
"location": "json",
243+
"required": false,
244+
"type": "integer"
245+
},
246+
"title": {
247+
"description": "Title of the page",
248+
"location": "json",
249+
"required": false,
250+
"type": "string"
251+
},
252+
"type": {
253+
"description": "Page type can be one of the following: page,error-page,index,home,error-404,list,single",
254+
"location": "json",
255+
"required": false,
256+
"type": "string"
257+
}
258+
},
259+
"summary": "Update a page of a site",
260+
"uri": "/sites/{siteRef}/pages/{pageRef}"
261+
},
262+
263+
"DeleteSitePage": {
264+
"httpMethod": "DELETE",
265+
"parameters": {
266+
"pageRef": {
267+
"description": "Page reference to be deleted. If a folder is provided, all child pages will be deleted.",
268+
"location": "uri",
269+
"required": true,
270+
"type": "integer"
271+
},
272+
"siteRef": {
273+
"description": "Site reference.",
274+
"location": "uri",
275+
"required": true,
276+
"type": "integer"
277+
}
278+
},
279+
"summary": "Delete a page or a redirect or a folder from a site",
280+
"uri": "/sites/{siteRef}/pages/{pageRef}"
281+
},
282+
283+
"Updatestaticvaluesforastaticwidget": {
284+
"httpMethod": "PUT",
285+
"parameters": {
286+
"values": {
287+
"description": "An array of key-value pairs describing the static widget",
288+
"location": "json",
289+
"required": true
290+
},
291+
"siteRef": {
292+
"description": "The site whose static widget’s values are to be updated",
293+
"location": "uri",
294+
"required": true,
295+
"type": "integer"
296+
},
297+
"staticWidgetId": {
298+
"description": "The static widget whose values are to be updated",
299+
"location": "uri",
300+
"required": true,
301+
"type": "string"
302+
}
303+
},
304+
"summary": "Changes the values associated with a site’s static widget",
305+
"uri": "/sites/{siteRef}/static-values/{staticWidgetId}"
306+
},
307+
45308
"MapDomain": {
46309
"httpMethod": "POST",
47310
"uri": "/sites/{siteRef}/domains",

0 commit comments

Comments
 (0)