<commit_before>==========
Categories
==========

.. note::

    These APIs are experimental and are currently being worked on. Endpoints
    may change without warning. Consider the :ref:`v3 API<api-stable-v3>`
    if you need stability.

-------------
Category List
-------------

.. _category-list:

Categories are defined by a name, a slug, a type and an application. Slugs are
only guaranteed to be unique for a given ``app`` and ``type`` combination, and
can therefore be re-used for different categories.

This endpoint is not paginated.

.. http:get:: /api/v4/addons/categories/

    :>json int id: The category id.
    :>json string name: The category name. Returns the already translated string.
    :>json string slug: The category slug. See :ref:`csv table <category-csv-table>` for more possible values.
    :>json string application: Application, see :ref:`add-on application <addon-detail-application>` for more details.
    :>json boolean misc: Whether or not the category is miscellaneous.
    :>json string type: Category type, see :ref:`add-on type <addon-detail-type>` for more details.
    :>json int weight: Category weight used in sort ordering.
    :>json string description: The category description. Returns the already translated string.


.. _category-csv-table:

------------------
Current categories
------------------

.. csv-table::
   :header: "Name", "Slug", "Type", "Application"

    "Alerts & Updates", alerts-updates, extension, firefox
    "Appearance", appearance, extension, firefox
    "Bookmarks", bookmarks, extension, firefox
    "Download Management", download-management, extension, firefox
    "Feeds, News & Blogging", feeds-news-blogging, extension, firefox
    "Games & Entertainment", games-entertainment, extension, firefox
    "Language Support", language-support, extension, firefox
    "Photos, Music & Videos", photos-music-videos, extension, firefox
    "Privacy & Security", privacy-security, extension, firefox<commit_msg>Make the category's description nullable in the doc (#9819)<commit_after>==========
Categories
==========

.. note::

    These APIs are experimental and are currently being worked on. Endpoints
    may change without warning. Consider the :ref:`v3 API<api-stable-v3>`
    if you need stability.

-------------
Category List
-------------

.. _category-list:

Categories are defined by a name, a slug, a type and an application. Slugs are
only guaranteed to be unique for a given ``app`` and ``type`` combination, and
can therefore be re-used for different categories.

This endpoint is not paginated.

.. http:get:: /api/v4/addons/categories/

    :>json int id: The category id.
    :>json string name: The category name. Returns the already translated string.
    :>json string slug: The category slug. See :ref:`csv table <category-csv-table>` for more possible values.
    :>json string application: Application, see :ref:`add-on application <addon-detail-application>` for more details.
    :>json boolean misc: Whether or not the category is miscellaneous.
    :>json string type: Category type, see :ref:`add-on type <addon-detail-type>` for more details.
    :>json int weight: Category weight used in sort ordering.
    :>json string|null description: The category description. Returns the already translated string.


.. _category-csv-table:

------------------
Current categories
------------------

.. csv-table::
   :header: "Name", "Slug", "Type", "Application"

    "Alerts & Updates", alerts-updates, extension, firefox
    "Appearance", appearance, extension, firefox
    "Bookmarks", bookmarks, extension, firefox
    "Download Management", download-management, extension, firefox
    "Feeds, News & Blogging", feeds-news-blogging, extension, firefox
    "Games & Entertainment", games-entertainment, extension, firefox
    "Language Support", language-support, extension, firefox
    "Photos, Music & Videos", photos-music-videos, extension, firefox
    "Privacy & Security", privacy-security, extension, firefox
{'fraction_non_alphanumeric': 0.1387989035634189, 'fraction_numerical': 0.0024919013207077, 'mean_word_length': 3.545866364665912, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 27, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4601113', 'n_tokens_mistral': 1106, 'n_tokens_neox': 1032, 'n_words': 425}