Skip to content

Commit 5d0f2c8

Browse files
eviljeffdiox
authored andcommitted
rm TAAR service integrations (mozilla#23147)
* rm TAAR service integrations * delete waffle switch too
1 parent 359898c commit 5d0f2c8

File tree

19 files changed

+102
-1018
lines changed

19 files changed

+102
-1018
lines changed

docs/topics/api/addons.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -957,7 +957,7 @@ Replacement Add-ons
957957

958958
.. _addon-replacement-addons:
959959

960-
This endpoint returns a list of suggested replacements for legacy add-ons that are unsupported in Firefox 57. Added to support the TAAR recommendation service.
960+
This endpoint returns a list of suggested replacements for legacy add-ons that are unsupported in Firefox 57.
961961

962962
.. http:get:: /api/v5/addons/replacement-addon/
963963
@@ -977,17 +977,16 @@ Recommendations
977977

978978
.. _addon-recommendations:
979979

980-
This endpoint provides recommendations of other addons to install, fetched from the `recommendation service <https://github.com/mozilla/taar>`_.
981-
Four recommendations are fetched, but only valid, publicly available addons are shown (so max 4 will be returned, and possibly less).
980+
This endpoint provides recommendations of other addons to install. Maximum four recommendations will be returned.
982981

983982
.. http:get:: /api/v5/addons/recommendations/
984983
985984
:query string app: Set the :ref:`add-on application <addon-detail-application>` for that query. This won't filter the results. Defaults to ``firefox``.
986985
:query string guid: Fetch recommendations for this add-on guid.
987986
:query string lang: Activate translations in the specific language for that query. (See :ref:`translated fields <api-overview-translations>`)
988-
:query boolean recommended: Fetch recommendations from the recommendation service, or return a curated fallback list instead.
989-
:>json string outcome: Outcome of the response returned. Will be either: ``recommended`` - responses from recommendation service; ``recommended_fallback`` - service timed out or returned empty or invalid results so we returned fallback; ``curated`` - ``recommended=False`` was requested so fallback returned.
990-
:>json string|null fallback_reason: if ``outcome`` was ``recommended_fallback`` then the reason why. Will be either: ``timeout``, ``no_results``, or ``invalid_results``.
987+
:query boolean recommended: Ignored.
988+
:>json string outcome: Outcome of the response returned. Will always be ``curated``.
989+
:>json null fallback_reason: Always null.
991990
:>json int count: The number of results for this query.
992991
:>json string next: The URL of the next page of results.
993992
:>json string previous: The URL of the previous page of results.

docs/topics/api/discovery.rst

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,17 @@ Firefox (about:addons).
2121

2222
.. note::
2323

24-
If a telemetry client id is passed as a parameter to the discovery pane api
25-
endpoint then static curated content is amended with recommendations from the
26-
`recommendation service <https://github.com/mozilla/taar>`_. The same number
27-
of results will be returned as a standard discovery response and only extensions
28-
(not themes) are recommended. Only valid, publicly available addons are shown.
29-
30-
E.g. a standard discovery pane will display 7 items, 4 extensions and 3 themes.
31-
Up to 4 extensions will be replaced with recommendations; the 3 themes will not
32-
be replaced. The API will still return a total of 7 items.
24+
A standard discovery pane will display 7 items, 4 extensions and 3 themes.
3325

3426
.. http:get:: /api/v5/discovery/
3527
36-
:query string lang: Activate translations in the specific language for that query. (See :ref:`translated fields <api-overview-translations>`)
28+
:query string lang: Activates translations. (See :ref:`translated fields <api-overview-translations>`)
3729
:query string edition: Optionally return content for a specific edition of Firefox. Currently only ``china`` (and the alias ``MozillaOnline``) is supported.
38-
:query string telemetry-client-id: Optional sha256 hash of the telemetry client ID to be passed to the TAAR service to enable recommendations. Must be the hex value of a sha256 hash, otherwise it will be ignored.
30+
:query string telemetry-client-id: Ignored. Was previously an optional sha256 hash of the telemetry client ID to be passed to the TAAR service to enable recommendations.
3931
:>json int count: The number of results for this query.
4032
:>json array results: The array containing the results for this query.
4133
:>json object|null results[].description_text: The description for this item, if any. (See :ref:`translated fields <api-overview-translations>`. Note: when ``lang`` is not specified, not all locales will be returned, unlike other translated fields).
42-
:>json boolean results[].is_recommendation: If this item was from the recommendation service, rather than static curated content.
34+
:>json boolean results[].is_recommendation: Always False.
4335
:>json object results[].addon: The :ref:`add-on <addon-detail-object>` for this item. Only a subset of fields are present: ``id``, ``authors``, ``average_daily_users``, ``current_version`` (with only the ``id``, ``compatibility``, ``is_strict_compatibility_enabled`` and ``file`` fields present), ``guid``, ``icon_url``, ``name``, ``ratings``, ``previews``, ``slug``, ``theme_data``, ``type`` and ``url``.
4436

4537

@@ -51,8 +43,7 @@ Editorial Content
5143

5244
This endpoint allows you to fetch all editorial content for Discovery Pane
5345
Recommendations. This is used internally to generate .po files containing the
54-
strings defined by the content team. It is also used by TAAR service to obtain a list
55-
of appropriate add-ons to recommended.
46+
strings defined by the content team.
5647

5748
.. http:get:: /api/v5/discovery/editorial/
5849

docs/topics/api/v3_legacy/addons.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ Replacement Add-ons
456456

457457
.. _v3-addon-replacement-addons:
458458

459-
This endpoint returns a list of suggested replacements for legacy add-ons that are unsupported in Firefox 57. Added to support the TAAR recommendation service.
459+
This endpoint returns a list of suggested replacements for legacy add-ons that are unsupported in Firefox 57.
460460

461461
.. http:get:: /api/v3/addons/replacement-addon/
462462
@@ -508,16 +508,15 @@ Recommendations
508508

509509
.. _v3-addon-recommendations:
510510

511-
This endpoint provides recommendations of other addons to install, fetched from the `recommendation service <https://github.com/mozilla/taar>`_.
512-
Four recommendations are fetched, but only valid, publicly available addons are shown (so max 4 will be returned, and possibly less).
511+
This endpoint provides recommendations of other addons to install. Maximum four recommendations will be returned.
513512

514513
.. http:get:: /api/v3/addons/recommendations/
515514
516515
:query string guid: Fetch recommendations for this add-on guid.
517516
:query string lang: Activate translations in the specific language for that query. (See :ref:`translated fields <v3-api-overview-translations>`)
518-
:query boolean recommended: Fetch recommendations from the recommendation service, or return a curated fallback list instead.
519-
:>json string outcome: Outcome of the response returned. Will be either: ``recommended`` - responses from recommendation service; ``recommended_fallback`` - service timed out or returned empty results so we returned fallback; ``curated`` - ``recommended=False`` was requested so fallback returned.
520-
:>json string|null fallback_reason: if ``outcome`` was ``recommended_fallback`` then the reason why. Will be either: ``timeout`` or ``no_results``.
517+
:query boolean recommended: Ignored.
518+
:>json string outcome: Outcome of the response returned. Will always be ``curated``.
519+
:>json null fallback_reason: Always null.
521520
:>json int count: The number of results for this query.
522521
:>json string next: The URL of the next page of results.
523522
:>json string previous: The URL of the previous page of results.

docs/topics/api/v3_legacy/discovery.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Firefox (about:addons).
2525
:>json array results: The array containing the results for this query.
2626
:>json string results[].heading: The heading for this item. May contain some HTML tags.
2727
:>json string|null results[].description: The description for this item, if any. May contain some HTML tags.
28-
:>json boolean results[].is_recommendation: If this item was from the recommendation service, rather than static curated content.
28+
:>json boolean results[].is_recommendation: Always False
2929
:>json object results[].addon: The :ref:`add-on <v3-addon-detail-object>` for this item. Only a subset of fields are present: ``id``, ``current_version`` (with only the ``compatibility`` and ``files`` fields present), ``guid``, ``icon_url``, ``name``, ``slug``, ``theme_data``, ``type`` and ``url``.
3030

3131

@@ -35,25 +35,21 @@ Discovery Recommendations
3535

3636
.. _v3-disco-recommendations:
3737

38-
If a telemetry client id is passed as a parameter to the discovery pane api
39-
endpoint then static curated content is amended with recommendations from the
40-
`recommendation service <https://github.com/mozilla/taar>`_. The same number
41-
of results will be returned as a standard discovery response and only extensions
42-
(not themes) are recommended. Only valid, publicly available addons are shown.
43-
4438
E.g. a standard discovery pane will display 7 items, 4 extensions and 3 themes.
4539
Up to 4 extensions will be replaced with recommendations; the 3 themes will not
4640
be replaced. The API will still return a total of 7 items.
4741

4842
.. note::
43+
A standard discovery pane will display 7 items, 4 extensions and 3 themes.
44+
4945
Specifying an ``edition`` parameter disables recommendations - the ``telemetry-client-id``
5046
is ignored and standard discovery response returned.
5147

5248

5349
.. http:get:: /api/v3/discovery/?telemetry-client-id=12345678-90ab-cdef-1234-567890abcdef
5450
55-
:query string telemetry-client-id: The telemetry client ID to be passed to the TAAR service.
56-
:query string lang: In addition to activating translations (see :ref:`Discovery Content <v3-disco-content>`), this will be passed as `locale` to TAAR.
57-
:query string platform: The platform identifier to be passed to TAAR.
58-
:query string branch: Additional parameter passed along to TAAR.
59-
:query string study: Additional parameter passed along to TAAR.
51+
:query string telemetry-client-id: Ignored. Was previously an optional sha256 hash of the telemetry client ID to be passed to the TAAR service to enable recommendations.
52+
:query string lang: Activates translations (see :ref:`Discovery Content <v3-disco-content>`).
53+
:query string platform: Ignored.
54+
:query string branch: Ignored.
55+
:query string study: Ignnored.

docs/topics/api/v4_frozen/addons.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ Replacement Add-ons
457457

458458
.. _v4-addon-replacement-addons:
459459

460-
This endpoint returns a list of suggested replacements for legacy add-ons that are unsupported in Firefox 57. Added to support the TAAR recommendation service.
460+
This endpoint returns a list of suggested replacements for legacy add-ons that are unsupported in Firefox 57.
461461

462462
.. http:get:: /api/v4/addons/replacement-addon/
463463
@@ -477,17 +477,15 @@ Recommendations
477477

478478
.. _v4-addon-recommendations:
479479

480-
This endpoint provides recommendations of other addons to install, fetched from the `recommendation service <https://github.com/mozilla/taar>`_.
481-
Four recommendations are fetched, but only valid, publicly available addons are shown (so max 4 will be returned, and possibly less).
480+
This endpoint provides recommendations of other addons to install. Maximum four recommendations will be returned.
482481

483482
.. http:get:: /api/v4/addons/recommendations/
484483
485484
:query string guid: Fetch recommendations for this add-on guid.
486485
:query string lang: Activate translations in the specific language for that query. (See :ref:`translated fields <v4-api-overview-translations>`)
487-
:query boolean recommended: Fetch recommendations from the recommendation service, or return a curated fallback list instead.
488-
:>json string outcome: Outcome of the response returned. Will be either: ``recommended`` - responses from recommendation service; ``recommended_fallback`` - service timed out or returned empty or invalid results so we returned fallback; ``curated`` - ``recommended=False`` was requested so fallback returned.
489-
:>json string|null fallback_reason: if ``outcome`` was ``recommended_fallback`` then the reason why. Will be either: ``timeout``, ``no_results``, or ``invalid_results``.
490-
:>json int count: The number of results for this query.
486+
:query boolean recommended: Ignored.
487+
:>json string outcome: Outcome of the response returned. Will always be ``curated``.
488+
:>json null fallback_reason: Always null.:>json int count: The number of results for this query.
491489
:>json string next: The URL of the next page of results.
492490
:>json string previous: The URL of the previous page of results.
493491
:>json array results: An array of :ref:`add-ons <v4-addon-detail-object>`. The following fields are omitted for performance reasons: ``release_notes`` and ``license`` fields on ``current_version`` and ``current_beta_version``, as well as ``picture_url`` from ``authors``.

docs/topics/api/v4_frozen/discovery.rst

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,17 @@ Firefox (about:addons).
2121

2222
.. note::
2323

24-
If a telemetry client id is passed as a parameter to the discovery pane api
25-
endpoint then static curated content is amended with recommendations from the
26-
`recommendation service <https://github.com/mozilla/taar>`_. The same number
27-
of results will be returned as a standard discovery response and only extensions
28-
(not themes) are recommended. Only valid, publicly available addons are shown.
29-
30-
E.g. a standard discovery pane will display 7 items, 4 extensions and 3 themes.
31-
Up to 4 extensions will be replaced with recommendations; the 3 themes will not
32-
be replaced. The API will still return a total of 7 items.
24+
A standard discovery pane will display 7 items, 4 extensions and 3 themes.
3325

3426
.. http:get:: /api/v4/discovery/
3527
36-
:query string lang: Activate translations in the specific language for that query. (See :ref:`translated fields <v4-api-overview-translations>`)
28+
:query string lang: Activates translations. (See :ref:`translated fields <v4-api-overview-translations>`)
3729
:query string edition: Optionally return content for a specific edition of Firefox. Currently only ``china`` (and the alias ``MozillaOnline``) is supported.
38-
:query string telemetry-client-id: Optional sha256 hash of the telemetry client ID to be passed to the TAAR service to enable recommendations. Must be the hex value of a sha256 hash, otherwise it will be ignored.
30+
:query string telemetry-client-id: Ignored. Was previously an optional sha256 hash of the telemetry client ID to be passed to the TAAR service to enable recommendations.
3931
:>json int count: The number of results for this query.
4032
:>json array results: The array containing the results for this query.
4133
:>json string|null results[].description_text: The description for this item, if any. Text-only, content might slightly differ from ``description`` because of that.
42-
:>json boolean results[].is_recommendation: If this item was from the recommendation service, rather than static curated content.
34+
:>json boolean results[].is_recommendation: Always False.
4335
:>json object results[].addon: The :ref:`add-on <v4-addon-detail-object>` for this item. Only a subset of fields are present: ``id``, ``authors``, ``average_daily_users``, ``current_version`` (with only the ``id``, ``compatibility``, ``is_strict_compatibility_enabled`` and ``files`` fields present), ``guid``, ``icon_url``, ``name``, ``ratings``, ``previews``, ``slug``, ``theme_data``, ``type`` and ``url``.
4436

4537

@@ -51,8 +43,7 @@ Editorial Content
5143

5244
This endpoint allows you to fetch all editorial content for Discovery Pane
5345
Recommendations. This is used internally to generate .po files containing the
54-
strings defined by the content team. It is also used by TAAR service to obtain a list
55-
of appropriate add-ons to recommended.
46+
strings defined by the content team.
5647

5748
.. http:get:: /api/v4/discovery/editorial/
5849

0 commit comments

Comments
 (0)