Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 7 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,36 +1,21 @@
.. image:: https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg
:target: https://github.com/mozilla/addons-server/blob/master/CODE_OF_CONDUCT.md
:target: https://github.com/thunderbird/addons-server/blob/master/CODE_OF_CONDUCT.md
:alt: Code of conduct

.. image:: https://travis-ci.org/mozilla/addons-server.svg?branch=master
:target: https://travis-ci.org/mozilla/addons-server

.. image:: https://pyup.io/repos/github/mozilla/addons-server/shield.svg
:target: https://pyup.io/repos/github/mozilla/addons-server/
:alt: Updates

.. image:: https://codecov.io/gh/mozilla/addons-server/branch/master/graph/badge.svg
:target: https://codecov.io/gh/mozilla/addons-server

.. image:: https://pyup.io/repos/github/mozilla/addons-server/python-3-shield.svg
:target: https://pyup.io/repos/github/mozilla/addons-server/
:alt: Python 3


Addons-Server
=============

Welcome to the Addons Server repository! Please feel free to visit the web page of the current project hosted on `addons.mozilla.org`_. If you want to install it follow our guide located in `install docs`_. We'd love your help! You can come talk to us on `irc.mozilla.org #amo`_ if you have any questions.
Welcome to the Addons Server repository! Please feel free to visit the web page of the current project hosted on `addons.thunderbird.net`_. If you want to install it follow our guide located in `install docs`_.

Please report bugs here: https://github.com/mozilla/addons/issues or https://github.com/mozilla/addons-server/issues
You can access the AMO dev environment at https://addons-dev.allizom.org/ and the AMO stage environment at https://addons.allizom.org/
Please report bugs here: https://github.com/thunderbird/addons-server/issues

You can join our mailing list at https://mail.mozilla.org/listinfo/dev-addons

.. _`addons.mozilla.org`: https://addons.mozilla.org
.. _`install docs`: https://addons-server.readthedocs.io/en/latest/topics/install/docker.html
.. _`irc.mozilla.org #amo`: irc://irc.mozilla.org/amo
You can find our mailing list and matrix channels at `www.thunderbird.net/get-involved`_

.. _`addons.thunderbird.net`: https://addons.thunderbird.net
.. _`install docs`: https://thunderbird-addons-server.readthedocs.io/en/latest/topics/install/docker.html
.. _`www.thunderbird.net/get-involved`: https://www.thunderbird.net/get-involved/#communication

.. marker-for-security-bug-inclusion-do-not-remove

Expand Down
4 changes: 2 additions & 2 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ If you're unsure, activate your ``virtualenv`` and run::

The documentation is viewable at http://addons-server.readthedocs.io/, and
covers development using Add-ons Server, the source code for `Add-ons
<https://addons.mozilla.org/>`_.
<https://addons.thunderbird.net/>`_.

Its source location is in the `/docs
<https://github.com/mozilla/addons-server/tree/master/docs>`_ folder.
<https://github.com/thunderbird/addons-server/tree/master/docs>`_ folder.

Note: this project was once called *olympia*, this documentation often uses
that term.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Welcome to Add-ons Servers documentation!
=========================================

Add-ons Server is the codebase for https://addons.mozilla.org/;
the source lives at https://github.com/mozilla/addons-server.
Add-ons Server is the codebase for https://addons.thunderbird.net/;
the source lives at https://github.com/thunderbird/addons-server.

In the past, this project was *olympia*; documentation that refers to olympia
refers to this project.
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/api/abuse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Submitting an add-on abuse report
.. _`addonabusereport-create`:

The following API endpoint allows an abuse report to be submitted for an Add-on,
either listed on https://addons.mozilla.org or not.
either listed on https://addons.thunderbird.net or not.
Authentication is not required, but is recommended so reports can be responded
to if nessecary.

Expand Down Expand Up @@ -46,7 +46,7 @@ Submitting a user abuse report
.. _`userabusereport-create`:

The following API endpoint allows an abuse report to be submitted for a user account
on https://addons.mozilla.org. Authentication is not required, but is recommended
on https://addons.thunderbird.net. Authentication is not required, but is recommended
so reports can be responded to if nessecary.

.. http:post:: /api/v4/abuse/report/user/
Expand Down
8 changes: 4 additions & 4 deletions docs/topics/api/accounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Other :ref:`editable values <account-edit-request>` can be set at the same time.

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v4/accounts/account/12345/"
curl "https://addons.thunderbird.net/api/v4/accounts/account/12345/"
-g -XPATCH --form "picture_upload=@photo.png"
-H "Authorization: Bearer <token>"

Expand Down Expand Up @@ -273,7 +273,7 @@ This allows you to generate a new user account and sign in as that user.

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v4/accounts/super-create/" \
curl "https://addons.thunderbird.net/api/v4/accounts/super-create/" \
-X POST -H "Authorization: JWT <jwt-token>"

**Response:**
Expand Down Expand Up @@ -304,7 +304,7 @@ This allows you to generate a new user account and sign in as that user.
.. sourcecode:: bash

curl --cookie sessionid=... -s -D - \
"https://addons.mozilla.org/en-US/developers/addon/submit/1" \
"https://addons.thunderbird.net/en-US/developers/addon/submit/1" \
-o /dev/null

.. _`session`:
Expand All @@ -323,7 +323,7 @@ sessions.

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v4/accounts/session/"
curl "https://addons.thunderbird.net/api/v4/accounts/session/"
-H "Authorization: Bearer <jwt-token>" -X DELETE

**Response:**
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/api/addons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ This endpoint allows you to fetch a specific add-on by id, slug or guid.
.. note::

For backwards-compatibility reasons, the value for type of Theme
currently live on production addons.mozilla.org is ``persona``
currently live on production addons.thunderbird.net is ``persona``
(Lightweight Theme). ``theme`` refers to a deprecated XUL Complete Theme.
New webextension packaged non-dynamic themes are ``statictheme``.

Expand Down Expand Up @@ -483,7 +483,7 @@ on AMO.
:>json string results[].type: The :ref:`add-on type <addon-detail-type>`.
:>json string results[].url: The (absolute) add-on detail URL.

.. _`valid application versions`: https://addons.mozilla.org/en-US/firefox/pages/appversions/
.. _`valid application versions`: https://addons.thunderbird.net/en-US/thunderbird/pages/appversions/


-------------------
Expand Down Expand Up @@ -535,7 +535,7 @@ Compatibilty overrides are used within Firefox i(and other toolkit applications
:>json int results[].version_ranges[].applications[].id: Application id on AMO.
:>json string results[].version_ranges[].applications[].min_version: minimum version of the application to be disabled in.
:>json string results[].version_ranges[].applications[].max_version: maximum version of the application to be disabled in.
:>json string results[].version_ranges[].applications[].guid: Application `guid <https://addons.mozilla.org/en-US/firefox/pages/appversions/>`_.
:>json string results[].version_ranges[].applications[].guid: Application `guid <https://addons.thunderbird.net/en-US/thunderbird/pages/appversions/>`_.


---------------
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/api/auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Using the :ref:`profile <profile>` as an example endpoint,
here's what a JWT authenticated HTTP request would look like in
`curl <http://curl.haxx.se/>`_::

curl "https://addons.mozilla.org/api/v4/accounts/profile/" \
curl "https://addons.thunderbird.net/api/v4/accounts/profile/" \
-H "Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ5b3VyLWFwaS1rZXkiLCJpYXQiOjE0NDcyNzMwOTYsImp0aSI6IjAuNDczNjI5NDQ2MjM0NTU0MDUiLCJleHAiOjE0NDcyNzMxNTZ9.TQ4B8GEm7UWZPcHuNGgjzD8EU9oUBVbL70Le1IeuYx0"


Expand All @@ -136,7 +136,7 @@ There are robust open source libraries for creating JWTs in
`all major programming languages <http://jwt.io/>`_.


.. _`manage-credentials`: https://addons.mozilla.org/en-US/developers/addon/api/key/
.. _`manage-credentials`: https://addons.thunderbird.net/en-US/developers/addon/api/key/
.. _`API Credentials Management Page`: manage-credentials_
.. _`credentials management page`: manage-credentials_
.. _`jwt-spec`: https://tools.ietf.org/html/rfc7519
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/api/github.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This API provides an endpoint that works with GitHub to provide add-on validatio
To set this up on a GitHub repository you will need to:

* Go to `Settings > Webhooks & Services`
* Add a new Webhook with Payload URL of `https://addons.mozilla.org/api/v4/github/validate/`
* Add a new Webhook with Payload URL of `https://addons.thunderbird.net/api/v4/github/validate/`
* Click `Send me everything`
* Click `Update webhook`

Expand Down
10 changes: 2 additions & 8 deletions docs/topics/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,19 @@
External API
============

This shows you how to use the `addons.mozilla.org <https://addons.mozilla.org/en-US/firefox/>`_
This shows you how to use the `addons.thunderbird.net <https://addons.thunderbird.net/>`_
API at ``/api/v4/`` which is hosted at the following URLs:

.. _api-environments:

=========== =========================================
Environment URL
=========== =========================================
Production ``https://addons.mozilla.org/api/v4/``
Staging ``https://addons.allizom.org/api/v4/``
Development ``https://addons-dev.allizom.org/api/v4/``
Production ``https://addons.thunderbird.net/api/v4/``
=========== =========================================

Production
Connect to this API for all normal operation.
Staging or Development
Connect to these APIs if you need to work with a scratch database or
you're testing features that aren't available in production yet.
Your production account is not linked to any of these APIs.

Dive into the :ref:`overview section <api-overview>` and the
:ref:`authentication section <api-auth>` for an example of how to get started
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/api/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Overview
if you need stability.

This describes the details of the requests and responses you can expect from
the `addons.mozilla.org <https://addons.mozilla.org/en-US/firefox/>`_ API.
the `addons.thunderbird.net <https://addons.thunderbird.net/>`_ API.

--------
Requests
Expand Down Expand Up @@ -183,7 +183,7 @@ Alternate API (v4dev) behavior

On the addons-dev.allizom.org (dev) and addons.allizom.org servers (stage) servers
an additional API version, `v4dev` is available. `v4dev` is not available on
production AMO (addons.mozilla.org). In `4dev` the response if the ``lang``
production AMO (addons.thunderbird.net). In `4dev` the response if the ``lang``
parameter is passed is an object only containing that translation is returned.

.. code-block:: json
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/api/reviewers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ add-on.
:>json string|null pending_info_request: Deadline date for the pending info request as a string, or ``null``.
:>json boolean needs_admin_code_review: Boolean indicating whether the add-on needs its code to be reviewed by an admin or not.
:>json boolean needs_admin_content_review: Boolean indicating whether the add-on needs its content to be reviewed by an admin or not.
:>json boolean needs_sensitive_access_review: Boolean indicating whether the add-on needs its content to be reviewed or not. This is related to the `Addon.require_sensitive_data_access` property.
:>json boolean needs_sensitive_data_access_review: Boolean indicating whether the add-on needs its content to be reviewed or not. This is related to the `Addon.require_sensitive_data_access` property.
14 changes: 7 additions & 7 deletions docs/topics/api/signing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ validation and you will be able to check its status.

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v4/addons/@my-addon/versions/1.0/"
curl "https://addons.thunderbird.net/api/v4/addons/@my-addon/versions/1.0/"
-g -XPUT --form "upload=@build/my-addon.xpi"
-H "Authorization: JWT <jwt-token>"

Expand Down Expand Up @@ -97,7 +97,7 @@ Uploading without an ID

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v4/addons/"
curl "https://addons.thunderbird.net/api/v4/addons/"
-g -XPOST -F "upload=@build/my-addon.xpi" -F "version=1.0"
-H "Authorization: JWT <jwt-token>"

Expand Down Expand Up @@ -153,7 +153,7 @@ automatically or after a manual review. Once review is complete then the

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v4/addons/@my-addon/versions/1.0/"
curl "https://addons.thunderbird.net/api/v4/addons/@my-addon/versions/1.0/"
-g -H "Authorization: JWT <jwt-token>"

:param addon-id: the id for the add-on.
Expand All @@ -170,7 +170,7 @@ automatically or after a manual review. Once review is complete then the
"automated_signing": true,
"files": [
{
"download_url": "https://addons.mozilla.org/api/v4/downloads/file/100/example-id.0-fx+an.xpi?src=api",
"download_url": "https://addons.thunderbird.net/api/v4/downloads/file/100/example-id.0-fx+an.xpi?src=api",
"hash": "sha256:1bb945266bf370170a656350d9b640cbcaf70e671cf753c410e604219cdd9267",
"signed": true
}
Expand All @@ -179,10 +179,10 @@ automatically or after a manual review. Once review is complete then the
"pk": "f68abbb3b1624c098fe979a409fe3ce9",
"processed": true,
"reviewed": true,
"url": "https://addons.mozilla.org/api/v4/addons/@example-id.0/uploads/f68abbb3b1624c098fe979a409fe3ce9/",
"url": "https://addons.thunderbird.net/api/v4/addons/@example-id.0/uploads/f68abbb3b1624c098fe979a409fe3ce9/",
"valid": true,
"validation_results": {},
"validation_url": "https://addons.mozilla.org/en-US/developers/upload/f68abbb3b1624c098fe979a409fe3ce9",
"validation_url": "https://addons.thunderbird.net/en-US/developers/upload/f68abbb3b1624c098fe979a409fe3ce9",
"version": "1.0"
}

Expand Down Expand Up @@ -230,7 +230,7 @@ This endpoint returns the actual file data for download.

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v4/file/123/some-addon.xpi?src=api"
curl "https://addons.thunderbird.net/api/v4/file/123/some-addon.xpi?src=api"
-g -H "Authorization: JWT <jwt-token>"

:param file_id: the primary key of the add-on file.
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/api/v3_legacy/abuse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Submitting an add-on abuse report
.. _`v3-addonabusereport-create`:

The following API endpoint allows an abuse report to be submitted for an Add-on,
either listed on https://addons.mozilla.org or not.
either listed on https://addons.thunderbird.net or not.
Authentication is not required, but is recommended so reports can be responded
to if nessecary.

Expand Down Expand Up @@ -40,7 +40,7 @@ Submitting a user abuse report
.. _`v3-userabusereport-create`:

The following API endpoint allows an abuse report to be submitted for a user account
on https://addons.mozilla.org. Authentication is not required, but is recommended
on https://addons.thunderbird.net. Authentication is not required, but is recommended
so reports can be responded to if nessecary.

.. http:post:: /api/v3/abuse/report/user/
Expand Down
8 changes: 4 additions & 4 deletions docs/topics/api/v3_legacy/accounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Other :ref:`editable values <v3-account-edit-request>` can be set at the same ti

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v3/accounts/account/12345/"
curl "https://addons.thunderbird.net/api/v3/accounts/account/12345/"
-g -XPATCH --form "picture_upload=@photo.png"
-H "Authorization: Bearer <token>"

Expand Down Expand Up @@ -266,7 +266,7 @@ This allows you to generate a new user account and sign in as that user.

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v3/accounts/super-create/" \
curl "https://addons.thunderbird.net/api/v3/accounts/super-create/" \
-X POST -H "Authorization: JWT <jwt-token>"

**Response:**
Expand Down Expand Up @@ -297,7 +297,7 @@ This allows you to generate a new user account and sign in as that user.
.. sourcecode:: bash

curl --cookie sessionid=... -s -D - \
"https://addons.mozilla.org/en-US/developers/addon/submit/1" \
"https://addons.thunderbird.net/en-US/developers/addon/submit/1" \
-o /dev/null

.. _`v3-session`:
Expand All @@ -316,7 +316,7 @@ sessions.

.. sourcecode:: bash

curl "https://addons.mozilla.org/api/v3/accounts/session/"
curl "https://addons.thunderbird.net/api/v3/accounts/session/"
-H "Authorization: Bearer <jwt-token>" -X DELETE

**Response:**
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/api/v3_legacy/addons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ on AMO.
:>json string results[].type: The :ref:`add-on type <v3-addon-detail-type>`.
:>json string results[].url: The (absolute) add-on detail URL.

.. _`valid application versions`: https://addons.mozilla.org/en-US/firefox/pages/appversions/
.. _`valid application versions`: https://addons.thunderbird.net/en-US/thunderbird/pages/appversions/


-------------------
Expand Down Expand Up @@ -527,7 +527,7 @@ Compatibilty overrides are used within Firefox i(and other toolkit applications
:>json int results[].version_ranges[].applications[].id: Application id on AMO.
:>json string results[].version_ranges[].applications[].min_version: minimum version of the application to be disabled in.
:>json string results[].version_ranges[].applications[].max_version: maximum version of the application to be disabled in.
:>json string results[].version_ranges[].applications[].guid: Application `guid <https://addons.mozilla.org/en-US/firefox/pages/appversions/>`_.
:>json string results[].version_ranges[].applications[].guid: Application `guid <https://addons.thunderbird.net/en-US/thunderbird/pages/appversions/>`_.


---------------
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/api/v3_legacy/auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Using the :ref:`profile <v3-profile>` as an example endpoint,
here's what a JWT authenticated HTTP request would look like in
`curl <http://curl.haxx.se/>`_::

curl "https://addons.mozilla.org/api/v3/accounts/profile/" \
curl "https://addons.thunderbird.net/api/v3/accounts/profile/" \
-H "Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ5b3VyLWFwaS1rZXkiLCJqdGkiOiIwLjQ3MzYyOTQ0NjIzNDU1NDA1IiwiaWF0IjoxNDQ3MjczMDk2LCJleHAiOjE0NDcyNzMxNTZ9.fQGPSV85QPhbNmuu86CIgZiluKBvZKd-NmzM6vo11DM"


Expand All @@ -134,7 +134,7 @@ There are robust open source libraries for creating JWTs in
`all major programming languages <http://jwt.io/>`_.


.. _`manage-credentials`: https://addons.mozilla.org/en-US/developers/addon/api/key/
.. _`manage-credentials`: https://addons.thunderbird.net/en-US/developers/addon/api/key/
.. _`API Credentials Management Page`: manage-credentials_
.. _`credentials management page`: manage-credentials_
.. _`jwt-spec`: https://tools.ietf.org/html/rfc7519
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/api/v3_legacy/github.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This API provides an endpoint that works with GitHub to provide add-on validatio
To set this up on a GitHub repository you will need to:

* Go to `Settings > Webhooks & Services`
* Add a new Webhook with Payload URL of `https://addons.mozilla.org/api/v3/github/validate/`
* Add a new Webhook with Payload URL of `https://addons.thunderbird.net/api/v3/github/validate/`
* Click `Send me everything`
* Click `Update webhook`

Expand Down
Loading
Loading