Skip to content

bugzilla
bugzilla
Commit a6a0f4e1 authored by Dave Lawrence's avatar Dave Lawrence
Browse files
Options

Bug 972465 - Update all REST documentation to prepend /rest/ to the examples to…

Bug 972465 - Update all REST documentation to prepend /rest/ to the examples to match mod_rewrite example r/a=glob
parent a62b8171
Hide whitespace changes
Inline Side-by-side
Showing with 40 additions and 40 deletions
Bugzilla/WebService/Bug.pm
View file @ a6a0f4e1
......@@ -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/<id_or_name>
GET /rest/field/bug/<id_or_name>
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/<product>
GET /rest/flag_types/<product>
To get information about flag_types for a product and component:
GET /flag_types/<product>/<component>
GET /rest/flag_types/<product>/<component>
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/<field_name>/values
GET /rest/field/bug/<field_name>/values
To get information based on field name and a specific product:
GET /field/bug/<field_name>/<product_id>/values
GET /rest/field/bug/<field_name>/<product_id>/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/<bug_id>/attachment
GET /rest/bug/<bug_id>/attachment
To get a specific attachment based on attachment ID:
GET /bug/attachment/<attachment_id>
GET /rest/bug/attachment/<attachment_id>
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/<id_or_alias>/comment
GET /rest/bug/<id_or_alias>/comment
To get a specific comment based on the comment ID:
GET /bug/comment/<comment_id>
GET /rest/bug/comment/<comment_id>
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/<id_or_alias>
GET /rest/bug/<id_or_alias>
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/<bug_id>/history
GET /rest/bug/<bug_id>/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/<bug_id>/attachment
POST /rest/bug/<bug_id>/attachment
The params to include in the POST body, as well as the returned
data format are the same as below. The C<ids> 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/<attach_id>
PUT /rest/bug/attachment/<attach_id>
The params to include in the POST body, as well as the returned
data format are the same as below. The C<ids> 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/<bug_id>/comment
POST /rest/bug/<bug_id>/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/<bug_id>
PUT /rest/bug/<bug_id>
The params to include in the PUT body as well as the returned data format,
are the same as below. The C<ids> 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/<query>
GET /rest/bug/comment/tags/<query>
=item B<Params>
......@@ -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.
......
Bugzilla/WebService/Bugzilla.pm
View file @ a6a0f4e1
......@@ -197,7 +197,7 @@ Returns the current version of Bugzilla.
=item B<REST>
GET /version
GET /rest/version
The returned data format is the same as below.
......@@ -233,7 +233,7 @@ in this Bugzilla.
=item B<REST>
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<REST>
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<REST>
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<REST>
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<REST>
GET /last_audit_time
GET /rest/last_audit_time
The returned data format is the same as below.
......
Bugzilla/WebService/Classification.pm
View file @ a6a0f4e1
......@@ -114,7 +114,7 @@ Returns a hash containing information about a set of classifications.
To return information on a single classification:
GET /classification/<classification_id_or_name>
GET /rest/classification/<classification_id_or_name>
The returned data format will be the same as below.
......
Bugzilla/WebService/Group.pm
View file @ a6a0f4e1
......@@ -131,7 +131,7 @@ This allows you to create a new group in Bugzilla.
=item B<REST>
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<REST>
PUT /group/<group_name_or_id>
PUT /rest/group/<group_name_or_id>
The params to include in the PUT body as well as the returned data format,
are the same as below. The C<ids> param will be overridden as it is pulled
......
Bugzilla/WebService/Product.pm
View file @ a6a0f4e1
......@@ -382,7 +382,7 @@ Returns a list of the ids of the products the user can search on.
=item B<REST>
GET /product_selectable
GET /rest/product_selectable
the returned data format is same as below.
......@@ -418,7 +418,7 @@ against.
=item B<REST>
GET /product_enterable
GET /rest/product_enterable
the returned data format is same as below.
......@@ -454,7 +454,7 @@ bugs against.
=item B<REST>
GET /product_accessible
GET /rest/product_accessible
the returned data format is same as below.
......@@ -496,16 +496,16 @@ B<Note>: 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<accessible>, C<selectable>, or C<enterable>:
GET /product?type=accessible
GET /rest/product?type=accessible
To return information about a specific product by C<id> or C<name>:
GET /product/<product_id_or_name>
GET /rest/product/<product_id_or_name>
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<REST>
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<REST>
PUT /product/<product_id_or_name>
PUT /rest/product/<product_id_or_name>
The params to include in the PUT body as well as the returned data format,
are the same as below. The C<ids> and C<names> params will be overridden as
......
Bugzilla/WebService/User.pm
View file @ a6a0f4e1
......@@ -629,7 +629,7 @@ call this function.
=item B<REST>
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<REST>
PUT /user/<user_id_or_name>
PUT /rest/user/<user_id_or_name>
The params to include in the PUT body as well as the returned data format,
are the same as below. The C<ids> and C<names> 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/<user_id_or_name>
GET /rest/user/<user_id_or_name>
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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment