diff options
author | David Lawrence <dkl@mozilla.com> | 2015-07-17 15:34:05 +0200 |
---|---|---|
committer | David Lawrence <dkl@mozilla.com> | 2015-07-17 15:34:05 +0200 |
commit | 5af060abe8347ccac35038d40577fd09c07f64c9 (patch) | |
tree | 4abbadde3716d0bd9ac6a049f74943f720715f51 /docs/en/rst/api/core/v1/classification.rst | |
parent | d988cb64c5fe8eb37750d568c2da1b8bdec583da (diff) | |
download | bugzilla-5af060abe8347ccac35038d40577fd09c07f64c9.tar.gz bugzilla-5af060abe8347ccac35038d40577fd09c07f64c9.tar.xz |
Bug 1177497: Backport upstreams 5.0 rST docs to BMO and make publicly available at https://bmo.readthedocs.org
Diffstat (limited to 'docs/en/rst/api/core/v1/classification.rst')
-rw-r--r-- | docs/en/rst/api/core/v1/classification.rst | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/docs/en/rst/api/core/v1/classification.rst b/docs/en/rst/api/core/v1/classification.rst new file mode 100644 index 000000000..ef5e58d1b --- /dev/null +++ b/docs/en/rst/api/core/v1/classification.rst @@ -0,0 +1,80 @@ +Classifications +=============== + +This part of the Bugzilla API allows you to deal with the available +classifications. You will be able to get information about them as well as +manipulate them. + +.. _rest_get_classification: + +Get Classification +------------------ + +Returns an object containing information about a set of classifications. + +**Request** + +To return information on a single classification using the ID or name: + +.. code-block:: text + + GET /rest/classification/(id_or_name) + +============== ===== ===================================== +name type description +============== ===== ===================================== +**id_or_name** mixed An Integer classification ID or name. +============== ===== ===================================== + +**Response** + +.. code-block:: js + + { + "classifications": [ + { + "sort_key": 0, + "description": "Unassigned to any classifications", + "products": [ + { + "id": 2, + "name": "FoodReplicator", + "description": "Software that controls a piece of hardware that will create any food item through a voice interface." + }, + { + "description": "Silk, etc.", + "name": "Spider Secretions", + "id": 4 + } + ], + "id": 1, + "name": "Unclassified" + } + ] + } + +``classifications`` (array) Each object is a classification that the user is +authorized to see and has the following items: + +=========== ====== ============================================================ +name type description +=========== ====== ============================================================ +id int The ID of the classification. +name string The name of the classification. +description string The description of the classificaion. +sort_key int The value which determines the order the classification is + sorted. +products array Products the user is authorized to + access within the classification. Each hash has the + following keys: +=========== ====== ============================================================ + +Product object: + +=========== ====== ================================ +name type description +=========== ====== ================================ +name string The name of the product. +id int The ID of the product. +description string The description of the product. +=========== ====== ================================ |