Sugar Network/Resources: Difference between revisions

Line 5:

| [[File:Sugar-Network-diagram.png|200px|thumb|Sugar Network objects]]

|}

'''Property types'''

Generally, Sugar Network objects' property types correspond to JSON types. The only exceptions mentioned in the following list:

* ''enum'', is an enumerated type when a value is a string from the predefined list of constants;

* ''markdown'', is a string formatted in the [[Wikipedia:Markdown|Markdown]] syntax;

* ''blob'', is a file represented by string value which is a [[Wikipedia:Sha1|SHA-1]] digest of file's content; the file itself can be obtained from the {{Code|'''GET''' /blobs/''DIGEST''}} request.

Line 26:

Line 36:

: This is a system level property to to track objects' condition. It is a list of states set by the system during the object life cycle. Users cannot directly write to this property. Currently supported states are:

:* ''featured'' the object is popped up by node editors;

:* ''featured'', the object is popped up by node editors;

:* ''deleted'' set after removing objects by users; right after user deletes, the object still remains in the system but becomes inaccessible to user requests;

:* ''deleted'', set after removing objects by users; right after user deletes, the object still remains in the system but becomes inaccessible to user requests;

:* ''favorite'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"stared"'' the context;

:* ''favorite'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"stared"'' the context;

:* ''checkin'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;

:* ''checkin'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;

:* ''stale'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if previously checked-in Context might have more fresh releases on the server; it is not possible to filter Contexts by this state;

:* ''stale'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if previously checked-in Context might have more fresh releases on the server; it is not possible to filter Contexts by this state;

:* ''inprogress'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if the Context is in the process of downloading content from the server; it is being temporally set before launching the Context of checking it in; it is not possible to filter Contexts by this state.

:* ''inprogress'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if the Context is in the process of downloading content from the server; it is being temporally set before launching the Context of checking it in; it is not possible to filter Contexts by this state.

@@ Line 5: / Line 5: @@
 | [[File:Sugar-Network-diagram.png|200px|thumb|Sugar Network objects]]
 |}
+<div id="types"></div>
+'''Property types'''
+Generally, Sugar Network objects' property types correspond to JSON types. The only exceptions mentioned in the following list:
+* ''enum'', is an enumerated type when a value is a string from the predefined list of constants;
+* ''markdown'', is a string formatted in the [[Wikipedia:Markdown|Markdown]] syntax;
+* ''blob'', is a file represented by string value which is a [[Wikipedia:Sha1|SHA-1]] digest of file's content; the file itself can be obtained from the {{Code|'''GET''' /blobs/''DIGEST''}} request.
 <div id="resource-author"></div>
@@ Line 26: / Line 36: @@
 : This is a system level property to to track objects' condition. It is a list of states set by the system during the object life cycle. Users cannot directly write to this property. Currently supported states are:
-:* ''featured'' the object is popped up by node editors;
+:* ''featured'', the object is popped up by node editors;
-:* ''deleted'' set after removing objects by users; right after user deletes, the object still remains in the system but becomes inaccessible to user requests;
+:* ''deleted'', set after removing objects by users; right after user deletes, the object still remains in the system but becomes inaccessible to user requests;
-:* ''favorite'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"stared"'' the context;
+:* ''favorite'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"stared"'' the context;
-:* ''checkin'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;
+:* ''checkin'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;
-:* ''stale'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if previously checked-in Context might have more fresh releases on the server; it is not possible to filter Contexts by this state;
+:* ''stale'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if previously checked-in Context might have more fresh releases on the server; it is not possible to filter Contexts by this state;
-:* ''inprogress'' applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if the Context is in the process of downloading content from the server; it is being temporally set before launching the Context of checking it in; it is not possible to filter Contexts by this state.
+:* ''inprogress'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if the Context is in the process of downloading content from the server; it is being temporally set before launching the Context of checking it in; it is not possible to filter Contexts by this state.
 <div id="context-type"></div>