From a6a0f4e17ba20c304417c26a842c01feb5ff51d3 Mon Sep 17 00:00:00 2001 From: Dave Lawrence Date: Tue, 18 Feb 2014 04:15:19 +0000 Subject: Bug 972465 - Update all REST documentation to prepend /rest/ to the examples to match mod_rewrite example r/a=glob --- Bugzilla/WebService/Bug.pm | 38 +++++++++++++++++------------------ Bugzilla/WebService/Bugzilla.pm | 12 +++++------ Bugzilla/WebService/Classification.pm | 2 +- Bugzilla/WebService/Group.pm | 4 ++-- Bugzilla/WebService/Product.pm | 16 +++++++-------- Bugzilla/WebService/User.pm | 8 ++++---- 6 files changed, 40 insertions(+), 40 deletions(-) (limited to 'Bugzilla') diff --git a/Bugzilla/WebService/Bug.pm b/Bugzilla/WebService/Bug.pm index 9ab217b04..9cc5ceafe 100644 --- a/Bugzilla/WebService/Bug.pm +++ b/Bugzilla/WebService/Bug.pm @@ -1491,11 +1491,11 @@ part is the request method and the rest is the related path needed. To get information about all fields: -GET /field/bug +GET /rest/field/bug To get information related to a single field: -GET /field/bug/ +GET /rest/field/bug/ The returned data format is the same as below. @@ -1722,11 +1722,11 @@ part is the request method and the rest is the related path needed. To get information about all flag types for a product: -GET /flag_types/ +GET /rest/flag_types/ To get information about flag_types for a product and component: -GET /flag_types// +GET /rest/flag_types// The returned data format is the same as below. @@ -1817,11 +1817,11 @@ Tells you what values are allowed for a particular field. To get information on the values for a field based on field name: -GET /field/bug//values +GET /rest/field/bug//values To get information based on field name and a specific product: -GET /field/bug///values +GET /rest/field/bug///values The returned data format is the same as below. @@ -1887,11 +1887,11 @@ insidergroup or if you are the submitter of the attachment. To get all current attachments for a bug: -GET /bug//attachment +GET /rest/bug//attachment To get a specific attachment based on attachment ID: -GET /bug/attachment/ +GET /rest/bug/attachment/ The returned data format is the same as below. @@ -2114,11 +2114,11 @@ and/or comment ids. To get all comments for a particular bug using the bug ID or alias: -GET /bug//comment +GET /rest/bug//comment To get a specific comment based on the comment ID: -GET /bug/comment/ +GET /rest/bug/comment/ The returned data format is the same as below. @@ -2290,7 +2290,7 @@ Note: Can also be called as "get_bugs" for compatibilty with Bugzilla 3.0 API. To get information about a particular bug using its ID or alias: -GET /bug/ +GET /rest/bug/ The returned data format is the same as below. @@ -2735,7 +2735,7 @@ Gets the history of changes for particular bugs in the database. To get the history for a specific bug ID: -GET /bug//history +GET /rest/bug//history The returned data format will be the same as below. @@ -3153,7 +3153,7 @@ likely change in the future. To create a new bug in Bugzilla: -POST /bug +POST /rest/bug The params to include in the POST body as well as the returned data format, are the same as below. @@ -3391,7 +3391,7 @@ This allows you to add an attachment to a bug in Bugzilla. To create attachment on a current bug: -POST /bug//attachment +POST /rest/bug//attachment The params to include in the POST body, as well as the returned data format are the same as below. The C param will be @@ -3563,7 +3563,7 @@ This allows you to update attachment metadata in Bugzilla. To update attachment metadata on a current attachment: -PUT /bug/attachment/ +PUT /rest/bug/attachment/ The params to include in the POST body, as well as the returned data format are the same as below. The C param will be @@ -3776,7 +3776,7 @@ This allows you to add a comment to a bug in Bugzilla. To create a comment on a current bug: -POST /bug//comment +POST /rest/bug//comment The params to include in the POST body as well as the returned data format, are the same as below. @@ -3878,7 +3878,7 @@ out about the changes. To update the fields of a current bug: -PUT /bug/ +PUT /rest/bug/ The params to include in the PUT body as well as the returned data format, are the same as below. The C param will be overridden as it is @@ -4589,7 +4589,7 @@ Searches for tags which contain the provided substring. To search for comment tags: -GET /bug/comment/tags/ +GET /rest/bug/comment/tags/ =item B @@ -4645,7 +4645,7 @@ Adds or removes tags from a comment. To update the tags comments attached to a comment: -PUT /bug/comment/tags +PUT /rest/bug/comment/tags The params to include in the PUT body as well as the returned data format, are the same as below. diff --git a/Bugzilla/WebService/Bugzilla.pm b/Bugzilla/WebService/Bugzilla.pm index 10ba38bab..6b5f9844f 100644 --- a/Bugzilla/WebService/Bugzilla.pm +++ b/Bugzilla/WebService/Bugzilla.pm @@ -197,7 +197,7 @@ Returns the current version of Bugzilla. =item B -GET /version +GET /rest/version The returned data format is the same as below. @@ -233,7 +233,7 @@ in this Bugzilla. =item B -GET /extensions +GET /rest/extensions The returned data format is the same as below. @@ -286,7 +286,7 @@ Returns the timezone that Bugzilla expects dates and times in. =item B -GET /timezone +GET /rest/timezone The returned data format is the same as below. @@ -324,7 +324,7 @@ what timezone it's running in. =item B -GET /time +GET /rest/time The returned data format is the same as below. @@ -406,7 +406,7 @@ Returns parameter values currently used in this Bugzilla. =item B -GET /parameters +GET /rest/parameters The returned data format is the same as below. @@ -485,7 +485,7 @@ Gets the latest time of the audit_log table. =item B -GET /last_audit_time +GET /rest/last_audit_time The returned data format is the same as below. diff --git a/Bugzilla/WebService/Classification.pm b/Bugzilla/WebService/Classification.pm index 22358c784..012af6268 100644 --- a/Bugzilla/WebService/Classification.pm +++ b/Bugzilla/WebService/Classification.pm @@ -114,7 +114,7 @@ Returns a hash containing information about a set of classifications. To return information on a single classification: -GET /classification/ +GET /rest/classification/ The returned data format will be the same as below. diff --git a/Bugzilla/WebService/Group.pm b/Bugzilla/WebService/Group.pm index 2d6689880..004804165 100644 --- a/Bugzilla/WebService/Group.pm +++ b/Bugzilla/WebService/Group.pm @@ -131,7 +131,7 @@ This allows you to create a new group in Bugzilla. =item B -POST /group +POST /rest/group The params to include in the POST body as well as the returned data format, are the same as below. @@ -221,7 +221,7 @@ This allows you to update a group in Bugzilla. =item B -PUT /group/ +PUT /rest/group/ The params to include in the PUT body as well as the returned data format, are the same as below. The C param will be overridden as it is pulled diff --git a/Bugzilla/WebService/Product.pm b/Bugzilla/WebService/Product.pm index f5a7f953f..97f84f413 100644 --- a/Bugzilla/WebService/Product.pm +++ b/Bugzilla/WebService/Product.pm @@ -382,7 +382,7 @@ Returns a list of the ids of the products the user can search on. =item B -GET /product_selectable +GET /rest/product_selectable the returned data format is same as below. @@ -418,7 +418,7 @@ against. =item B -GET /product_enterable +GET /rest/product_enterable the returned data format is same as below. @@ -454,7 +454,7 @@ bugs against. =item B -GET /product_accessible +GET /rest/product_accessible the returned data format is same as below. @@ -496,16 +496,16 @@ B: Can also be called as "get_products" for compatibilty with Bugzilla 3.0 To return information about a specific groups of products such as C, C, or C: -GET /product?type=accessible +GET /rest/product?type=accessible To return information about a specific product by C or C: -GET /product/ +GET /rest/product/ You can also return information about more than one specific product by using the following in your query string: -GET /product?ids=1&ids=2&ids=3 or GET /product?names=ProductOne&names=Product2 +GET /rest/product?ids=1&ids=2&ids=3 or GET /product?names=ProductOne&names=Product2 the returned data format is same as below. @@ -730,7 +730,7 @@ This allows you to create a new product in Bugzilla. =item B -POST /product +POST /rest/product The params to include in the POST body as well as the returned data format, are the same as below. @@ -838,7 +838,7 @@ This allows you to update a product in Bugzilla. =item B -PUT /product/ +PUT /rest/product/ The params to include in the PUT body as well as the returned data format, are the same as below. The C and C params will be overridden as diff --git a/Bugzilla/WebService/User.pm b/Bugzilla/WebService/User.pm index 09585ebfe..c440d135d 100644 --- a/Bugzilla/WebService/User.pm +++ b/Bugzilla/WebService/User.pm @@ -629,7 +629,7 @@ call this function. =item B -POST /user +POST /rest/user The params to include in the POST body as well as the returned data format, are the same as below. @@ -695,7 +695,7 @@ Updates user accounts in Bugzilla. =item B -PUT /user/ +PUT /rest/user/ The params to include in the PUT body as well as the returned data format, are the same as below. The C and C params are overridden as they @@ -813,11 +813,11 @@ Gets information about user accounts in Bugzilla. To get information about a single user: -GET /user/ +GET /rest/user/ To search for users by name, group using URL params same as below: -GET /user +GET /rest/user The returned data format is the same as below. -- cgit v1.2.3-24-g4f1b