[Bps-public-commit] rt-extension-rest2 01/02: Update generated files

[sunnavy]

This is an automated email from the git hooks/post-receive script.

sunnavy pushed a commit to branch master
in repository rt-extension-rest2.

commit 485f496991306f6bd1cf298132ff8af4a9137efc
Author: sunnavy <sunnavy at bestpractical.com>
AuthorDate: Tue Jul 20 02:19:56 2021 +0800

    Update generated files
---
 README | 56 +++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 49 insertions(+), 7 deletions(-)

diff --git a/README b/README
index 710adb9..60fd423 100644
--- a/README
+++ b/README
@@ -411,8 +411,19 @@ USAGE
         GET /tickets?simple=1;query=<simple search query>
             search for tickets using simple search syntax
 
+        # If there are multiple saved searches using the same description, the
+        # behavior of "which saved search shall be selected" is undefined, use
+        # id instead in this case.
+
+        # If both search and other arguments like "query" are specified, the
+        # latter takes higher precedence than the corresponding fields defined
+        # in the given saved search.
+
+        GET /tickets?search=<saved search id or description>
+            search for tickets using saved search
+
         POST /tickets
-            search for tickets with the 'query' and optional 'simple' parameters
+            search for tickets with the 'search' or 'query' and optional 'simple' parameters 
 
         POST /ticket
             create a ticket; provide JSON content
@@ -755,6 +766,15 @@ USAGE
         GET /customrole/:id
             retrieve a custom role
 
+   Saved Searches
+        GET /searches?query=<JSON>
+        POST /searches
+            search for saved searches using L</JSON searches> syntax
+
+        GET /search/:id
+        GET /search/:description
+            retrieve a saved search
+
    Miscellaneous
         GET /
             produces this documentation
@@ -1036,14 +1056,14 @@ USAGE
     example (line wrapping inserted for readability):
 
         XX_RT_URL_XX/REST/2.0/tickets
-          ?fields=Owner,Status,Created,Subject,Queue,CustomFields
+          ?fields=Owner,Status,Created,Subject,Queue,CustomFields,Requestor,Cc,AdminCc,RT::CustomRole-1
           &fields[Queue]=Name,Description
 
     Says that in the result set for tickets, the extra fields for Owner,
-    Status, Created, Subject, Queue and CustomFields should be included. But
-    in addition, for the Queue block, also include Name and Description. The
-    results would be similar to this (only one ticket is displayed in this
-    example):
+    Status, Created, Subject, Queue, CustomFields, Requestor, Cc, AdminCc
+    and CustomRoles should be included. But in addition, for the Queue
+    block, also include Name and Description. The results would be similar
+    to this (only one ticket is displayed in this example):
 
        "items" : [
           {
@@ -1073,8 +1093,30 @@ USAGE
                      "name" : "My Custom Field",
                      "values" : [
                          "CustomField value"
-                     },
+                     ]
                  }
+             ],
+             "Requestor" : [
+                {
+                   "id" : "root",
+                   "type" : "user",
+                   "_url" : "XX_RT_URL_XX/REST/2.0/user/root"
+                }
+             ],
+             "Cc" : [
+                {
+                   "id" : "root",
+                   "type" : "user",
+                   "_url" : "XX_RT_URL_XX/REST/2.0/user/root"
+                }
+             ],
+             "AdminCc" : [],
+             "RT::CustomRole-1" : [
+                {
+                   "_url" : "XX_RT_URL_XX/REST/2.0/user/foo at example.com",
+                   "type" : "user",
+                   "id" : "foo at example.com"
+                }
              ]
           }
           { … },

-- 
To stop receiving notification emails like this one, please contact
sysadmin at bestpractical.com.