Adjust references to XMLRPC to mention REST

crobinso · crobinso · commit c9e2cf76bae1 · 2020-07-04T14:03:28.000-04:00
With REST in the mix we need to make these more generic

Signed-off-by: Cole Robinson &lt;crobinso@redhat.com&gt;
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 This package provides two bits:
 
-* 'bugzilla' python module for talking to a [Bugzilla](https://www.bugzilla.org/) instance over XMLRPC
+* 'bugzilla' python module for talking to a [Bugzilla](https://www.bugzilla.org/) instance over XMLRPC or REST
 * /usr/bin/bugzilla command line tool for performing actions from the command line: create or edit bugs, various queries, etc.
 
 This was originally written specifically for Red Hat's Bugzilla instance
diff --git a/bugzilla/_cli.py b/bugzilla/_cli.py
@@ -101,7 +101,7 @@ def _setup_root_parser():
 
     # General bugzilla connection options
     p.add_argument('--bugzilla', default=default_url,
-            help="bugzilla XMLRPC URI. default: %s" % default_url)
+            help="bugzilla URI. default: %s" % default_url)
     p.add_argument("--nosslverify", dest="sslverify",
                  action="store_false", default=True,
                  help="Don't error on invalid bugzilla SSL certificate")
@@ -258,7 +258,7 @@ def _parser_add_bz_fields(rootp, command):
     # Put this at the end, so it sticks out more
     p.add_argument('--field',
         metavar="FIELD=VALUE", action="append", dest="fields",
-        help="Manually specify a bugzilla XMLRPC field. FIELD is "
+        help="Manually specify a bugzilla API field. FIELD is "
         "the raw name used by the bugzilla instance. For example, if your "
         "bugzilla instance has a custom field cf_my_field, do:\n"
         "  --field cf_my_field=VALUE")
@@ -969,7 +969,7 @@ def _do_modify(bz, parser, opt):
     # Now for the things we can't blindly batch.
     # Being able to prepend/append to whiteboards, which are just
     # plain string values, is an old rhbz semantic that we try to maintain
-    # here. This is a bit weird for traditional bugzilla XMLRPC
+    # here. This is a bit weird for traditional bugzilla API
     log.debug("Adjusting whiteboard fields one by one")
     for bug in bz.getbugs(bugid_list):
         update_kwargs = {}
diff --git a/examples/bug_autorefresh.py b/examples/bug_autorefresh.py
@@ -51,6 +51,6 @@
 # Why does this matter? Some scripts are implicitly depending on this
 # auto-refresh behavior, because their include_fields specification doesn't
 # cover all attributes they actually use. Your script will work, sure, but
-# it's likely doing many more XML-RPC calls than needed, possibly 1 per bug.
+# it's likely doing many more API calls than needed, possibly 1 per bug.
 # So if after upgrading python-bugzilla you start hitting issues, the
 # recommendation is to fix your include_fields.
diff --git a/examples/create.py b/examples/create.py
@@ -25,7 +25,7 @@
 # Similar to build_query, build_createbug is a helper function that handles
 # some bugzilla version incompatibility issues. All it does is return a
 # properly formatted dict(), and provide friendly parameter names.
-# The argument names map to those accepted by XMLRPC Bug.create:
+# The argument names map to those accepted by Bugzilla Bug.create:
 # https://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#create-bug
 #
 # The arguments specified here are mandatory, but there are many other
diff --git a/examples/getbug_restapi.py b/examples/getbug_restapi.py
@@ -16,7 +16,7 @@
 
 # By default, if plain Bugzilla(URL) is invoked, the Bugzilla class will
 # attempt to determine if XMLRPC or REST API is available, with a preference
-# for XMLRPC for back compatability. But you can for use for the REST API
+# for XMLRPC for back compatability. But you can use the REST API
 # with force_rest=True
 bzapi = bugzilla.Bugzilla(URL, force_rest=True)
 
diff --git a/examples/query.py b/examples/query.py
@@ -20,7 +20,7 @@
 # build_query is a helper function that handles some bugzilla version
 # incompatibility issues. All it does is return a properly formatted
 # dict(), and provide friendly parameter names. The param names map
-# to those accepted by XMLRPC Bug.search:
+# to those accepted by Bugzilla Bug.search:
 # https://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#search-bugs
 query = bzapi.build_query(
     product="Fedora",
diff --git a/examples/update.py b/examples/update.py
@@ -22,7 +22,7 @@
 # Similar to build_query, build_update is a helper function that handles
 # some bugzilla version incompatibility issues. All it does is return a
 # properly formatted dict(), and provide friendly parameter names.
-# The param names map to those accepted by XMLRPC Bug.update:
+# The param names map to those accepted by Bugzilla Bug.update:
 # https://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#update-bug
 #
 # Example bug: https://partner-bugzilla.redhat.com/show_bug.cgi?id=427301
diff --git a/python-bugzilla.spec b/python-bugzilla.spec
@@ -42,7 +42,7 @@ BuildRequires: python3-pytest
 
 %global _description\
 python-bugzilla is a python library for interacting with bugzilla instances\
-over XML-RPC.\
+over XMLRPC or REST.\
 
 %description %_description
 

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`# Similar to build_query, build_createbug is a helper function that handles`
`26`	`26`	`# some bugzilla version incompatibility issues. All it does is return a`
`27`	`27`	`# properly formatted dict(), and provide friendly parameter names.`
`28`		`-# The argument names map to those accepted by XMLRPC Bug.create:`
	`28`	`+# The argument names map to those accepted by Bugzilla Bug.create:`
`29`	`29`	`# https://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#create-bug`
`30`	`30`	`#`
`31`	`31`	`# The arguments specified here are mandatory, but there are many other`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`# Similar to build_query, build_update is a helper function that handles`
`23`	`23`	`# some bugzilla version incompatibility issues. All it does is return a`
`24`	`24`	`# properly formatted dict(), and provide friendly parameter names.`
`25`		`-# The param names map to those accepted by XMLRPC Bug.update:`
	`25`	`+# The param names map to those accepted by Bugzilla Bug.update:`
`26`	`26`	`# https://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#update-bug`
`27`	`27`	`#`
`28`	`28`	`# Example bug: https://partner-bugzilla.redhat.com/show_bug.cgi?id=427301`