[isidorus-cvs] r278 - trunk/docs

[Lukas Giessmann]

Author: lgiessmann
Date: Wed Apr 14 10:52:52 2010
New Revision: 278

Log:
docs: added documentation to the RESTful-interface --> mark-as-deleted-handler

Modified:
   trunk/docs/json.ebnf
   trunk/docs/xtm_json.txt

Modified: trunk/docs/json.ebnf
==============================================================================
--- trunk/docs/json.ebnf	(original)
+++ trunk/docs/json.ebnf	Wed Apr 14 10:52:52 2010
@@ -4,7 +4,7 @@
 //+  *Part 2: XTM - data model
 //+  *Part 3: Object summaries
 //+  *Part 4: TMCL - data model
-//+  *Part 5: Server-side RESTful interface
+//+  *Part 5: Object notation for marking objects as deleted
 //+-----------------------------------------------------------------------------
 
 //+-----------------------------------------------------------------------------
@@ -173,16 +173,36 @@
 
 // Contains the entire TMCL information
 FragmentConstraint ="{" TopicConstraints "," AssociationsConstraints "}"
+
+
 //+-----------------------------------------------------------------------------
-//+ Part 5: Server-side RESTful interface
-//+-----------------------------------------------------------------------------
-"/json/get/(.+)$" returns a Fragment after a HTTP-GET
-"/json/commit/?$" processes a Fragment as HTTP-POST or HTTP-PUT
-"/json/psis/?$" returns a PsiSummary after a HTTP-GET
-"/json/summary/?$" returns a TopicSummaries after A HTTP-GET
-"/json/tmcl/types/?$" returns a PsiSummary after A HTTP-GET with all types
-"/json/tmcl/instances/?$" returns a PsiSummary after a HTTP-GET with all instances
-"/json/topicstubs/(.+)$" returns a topicStub after a HTTP-GET
-"/json/tmcl/type/?$" returns a FragmentConstraint after a HTTP-POST/HTTP-PUT
-"/json/tmcl/instance/?$" returns a FragmentConstraint after a HTTP-POST/HTTP-PUT
-"/json/tmcl/overview/?$" returns a TreeView after a HTTP-GET
\ No newline at end of file
+//+ Part 5: Object notation for marking objects as deleted
+//+    type: the type of the deleted object, e.g. Topic for TopicC
+//+    topics: a list of PSIs, where every single PSI represents a topic that
+//+            has to be deleted
+//+    associations: a list of associations that have to be deleted
+//+    parent-topic: a single PSI of the name's, occurrence's or variant's owner
+//+                  topic
+//+    parent-name: the parent name of the variants that have to be deleted
+//+                 (in this case the parent-topic is the topic of the name)
+//+    names: a list of the deletable names
+//+    variants: a list of deletable names
+//+    occurrences: a list of the deletable occurrences
+//+    parent-association: the parent association of the deletable roles
+//+    roles: a list of the deltable roles
+//+-----------------------------------------------------------------------------
+DeleteType = "\"type\":" ("Topic" | "Occurrence" | "Name" | "Association" | "Role" | "Variant")
+DeleteTopics = "\"topics\":" List
+DeleteAssociations = "\"associations\":" Associations
+DeleteParentTopic = "\"parent-topic\":" String
+DeleteParentName = "\"parent-name\":" Name
+DeleteNames = "\"names\":" Names
+DeleteVariants = "\"variants\":" Variants
+DeleteOccurrences = "\"occurrences\":" Occurrences
+DeleteParentAssociation = "\"parent-association\":" Association
+DeleteRoles = "\"roles\":" Roles
+
+DeleteObject = "{" DeleteType "," DeleteTopics "," DeleteAssociations ","
+               DeleteParentTopic "," DeleteParentName "," DeleteNames ","
+               DeleteVariants "," DeleteOccurrences "," DeleteParentAssociation
+               "," DeleteRoles "}"
\ No newline at end of file

Modified: trunk/docs/xtm_json.txt
==============================================================================
--- trunk/docs/xtm_json.txt	(original)
+++ trunk/docs/xtm_json.txt	Wed Apr 14 10:52:52 2010
@@ -3,6 +3,7 @@
 //+  *Part 1: XTM - data model
 //+  *Part 2: Object summaries
 //+  *Part 3: TMCL - data model
+//+  *Part 4: Object notation for marking objects as deleted
 //+-----------------------------------------------------------------------------
 
 
@@ -443,3 +444,34 @@
   "topicConstraints" : <topicConstraint>,
   "associationsConstraints" : [ <associationConstraints>, <...> ]
 }
+
+
+
+//+-----------------------------------------------------------------------------
+//+  *Part 4: Object notation for marking objects as deleted
+//+    type: the type of the deleted object, e.g. Topic for TopicC
+//+    topics: a list of PSIs, where every single PSI represents a topic that
+//+            has to be deleted
+//+    associations: a list of associations that have to be deleted
+//+    parent-topic: a single PSI of the name's, occurrence's or variant's owner
+//+                  topic
+//+    parent-name: the parent name of the variants that have to be deleted
+//+                 (in this case the parent-topic is the topic of the name)
+//+    names: a list of the deletable names
+//+    variants: a list of deletable names
+//+    occurrences: a list of the deletable occurrences
+//+    parent-association: the parent association of the deletable roles
+//+    roles: a list of the deltable roles
+//+-----------------------------------------------------------------------------
+{
+  "type":<"Topic" | "Occurrence" | "Name" | "Association" | "Role" | "Variant" >,
+  "topics": [<psi-top-1>, <psi-top-2>, <...>],
+  "associations": [<association-1>, <association-2>, <...>],
+  "parent-topic": "topic-psi",
+  "parent-name": <name>,
+  "names": [<name-1>, <name-2>, <...>],
+  "variants": [<variant-1>, <variant-2>, <...>],
+  "occurrences": [<occurrence-1>, <occurrence-2>, <...>],
+  "parent-association": <association>,
+  "roles": [<role-1>, <role-2>, <...>]
+}