<
From version < 9.3 >
edited by Silvia Macovei
on 2009/10/06
To version < 10.3 >
edited by Silvia Macovei
on 2009/10/08
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  This section contains a brief and high-level description of the XWiki data set that should serve as a basis for presenting resources and their associated operations.
8 8  
9 -XWiki has **pages** organized in **spaces**. Each **page** is available in multiple **versions** (its **history**) and **translations**. Translated pages have their own **versions** and **history** which are independent. Each page might have **attachments**. Each attachment has its own **history**. Attachments are shared among all the different translations of a page (i.e., the same set of attachment is the same regardless of the page language). Pages can have one or more **objects**. Objects are instances of a **class** that contains a set of **properties**. Some object might be directly exposed as first class entities, such as **comments** and **tags**. Objects, as attachments, are shared among all page translations.
9 +XWiki has **pages** organized in **spaces**. Each **page** is available in multiple **versions** (its **history**) and **translations**. Translated pages have their own **versions** and **history** which are independent. Each page might have **attachments**. Each attachment has its own **history**. Attachments are shared among all the different translations of a page (i.e., the same set of attachments is the same regardless of the page language). Pages can have one or more **objects**. Objects are instances of a **class** that contains a set of **properties**. Some objects might be directly exposed as first class entities, such as **comments** and **tags**. Objects, as attachments, are shared among all page translations.
10 10  
11 11  == Understanding resources and representations ==
12 12  
... ... @@ -208,10 +208,8 @@
208 208  ** **Status codes:**
209 209  *** 200: If the request was successful.
210 210  
211 -==== /wikis/{wikiName}/search?q ====
211 +==== /wikis/{wikiName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...~]&number~=n~] ====
212 212  
213 -{keywords}[[[&scope={name,content,title,objects}...]]&number=n] ====
214 -
215 215  * **HTTP Method:** GET
216 216  ** **Media types:**
217 217  *** application/xml (SearchResults element)
... ... @@ -221,7 +221,7 @@
221 221  
222 222  === Space resources ===
223 223  
224 -==== /wikis/{wikiName}/spaces[[?start=offset&number=n]] ====
222 +==== /wikis/{wikiName}/spaces[?start~=offset&number~=n] ====
225 225  
226 226  * **HTTP Method:** GET
227 227  ** **Media types:**
... ... @@ -230,10 +230,8 @@
230 230  ** **Status codes:**
231 231  *** 200: If the request was successful.
232 232  
233 -==== /wikis/{wikiName}/spaces/{spaceName}/search?q ====
231 +==== /wikis/{wikiName}/spaces/{spaceName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...~]&number~=n~] ====
234 234  
235 -{keywords}[[[&scope={name,content,title,objects}...]]&number=n] ====
236 -
237 237  * **HTTP Method:** GET
238 238  ** **Media types:**
239 239  *** application/xml (Search results element)
... ... @@ -244,7 +244,7 @@
244 244  
245 245  === Page resources ===
246 246  
247 -==== /wikis/{wikiName}/spaces/{spaceName}/pages[[?start=offset&number=n]] ====
243 +==== /wikis/{wikiName}/spaces/{spaceName}/pages[?start~=offset&number~=n] ====
248 248  
249 249  * **HTTP Method:** GET
250 250  ** **Media types:**
... ... @@ -290,7 +290,7 @@
290 290  *** 204: If the request was successful.
291 291  *** 401: If the user is not authorized.
292 292  
293 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history[[?start=offset&number=n]] ====
289 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history[?start~=offset&number~=n] ====
294 294  
295 295  * **HTTP Method:** GET
296 296  ** **Media types:**
... ... @@ -310,7 +310,7 @@
310 310  *** 200: If the request was successful.
311 311  *** 401: If the user is not authorized.
312 312  
313 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/translations[[?start=offset&number=n]] ====
309 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/translations[?start~=offset&number~=n] ====
314 314  
315 315  * **HTTP Method:** GET
316 316  ** **Media types:**
... ... @@ -422,7 +422,7 @@
422 422  *** 200: If the request was successful.
423 423  *** 401: If the user is not authorized.
424 424  
425 -==== /wikis/{wikiName}/tags/{tag1}[[,{tag2},{tag3}...]][[?start=offset&number=n]] ====
421 +==== /wikis/{wikiName}/tags/{tag1}[,{tag2},{tag3}...][?start~=offset&number~=n] ====
426 426  
427 427  * **HTTP Method:** GET
428 428  ** **Media types:**
... ... @@ -434,7 +434,7 @@
434 434  
435 435  === Comments resources ===
436 436  
437 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/comments[[?start=offset&number=n]] ====
433 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/comments[?start~=offset&number~=n] ====
438 438  
439 439  * **HTTP Method:** GET
440 440  ** **Media types:**
... ... @@ -490,7 +490,7 @@
490 490  
491 491  === Attachments resources ===
492 492  
493 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/attachments[[?start=offset&number=n]] ====
489 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/attachments[?start~=offset&number~=n] ====
494 494  
495 495  * **HTTP Method:** GET
496 496  ** **Media types:**
... ... @@ -532,7 +532,7 @@
532 532  *** 204: If the attachment was deleted.
533 533  *** 401: If the user is not authorized.
534 534  
535 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/attachments[[?start=offset&number=n]] ====
531 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/attachments[?start~=offset&number~=n] ====
536 536  
537 537  * **HTTP Method:** GET
538 538  ** **Media types:**
... ... @@ -574,7 +574,7 @@
574 574  
575 575  === Object resources ===
576 576  
577 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects[[?start=offset&number=n]] ====
573 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects[?start~=offset&number~=n] ====
578 578  
579 579  * **HTTP Method:** GET
580 580  ** **Media types:**
... ... @@ -597,7 +597,7 @@
597 597  *** 201: If the object was created (The Location header will contain the URI associated to the newly created object).
598 598  *** 401: If the user is not authorized.
599 599  
600 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects/{className}[[?start=offset&number=n]] ====
596 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects/{className}[?start~=offset&number~=n] ====
601 601  
602 602  * **HTTP Method:** GET
603 603  ** **Media types:**
... ... @@ -673,7 +673,7 @@
673 673  *** 202: If the object was updated.
674 674  *** 401: If the user is not authorized.
675 675  
676 -==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/objects[[?start=offset&number=n]] ====
672 +==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/objects[?start~=offset&number~=n] ====
677 677  
678 678  * **HTTP Method:** GET
679 679  ** **Media types:**
... ... @@ -725,7 +725,7 @@
725 725  
726 726  === Class resources ===
727 727  
728 -==== /wikis/{wikiName}/classes[[?start=offset&number=n]] ====
724 +==== /wikis/{wikiName}/classes[?start~=offset&number~=n] ====
729 729  
730 730  * **HTTP Method:** GET
731 731  ** **Media types:**
... ... @@ -767,7 +767,7 @@
767 767  
768 768  === Other resources ===
769 769  
770 -==== /wikis/{wikiName}/modifications[[?start=offset&number=n&timestamp=t]] ====
766 +==== /wikis/{wikiName}/modifications[?start~=offset&number~=n&timestamp~=t] ====
771 771  
772 772  * **HTTP Method:** GET
773 773  ** **Media types:**

Get Connected