Clarify that `channel` is a form parameter in the signing API (#7704)

This commit is contained in:
Kumar McMillan 2018-03-06 09:11:23 -06:00 коммит произвёл Andrew Williamson
Родитель 3e5fd1b263
Коммит d10ada5c51
1 изменённых файлов: 9 добавлений и 9 удалений

Просмотреть файл

@ -54,19 +54,19 @@ validation and you will be able to check its status.
:param version: The version of the add-on. A version ending with
``a``, ``alpha``, ``b``, or ``beta`` and an optional number is
detected as beta. For example: ``2.0-beta1`` or ``1.2a``.
:param channel: (optional) The version channel this version should uploaded
to, which determines its visibility on the site. Can be either
``unlisted`` or ``listed``. See note below.
:form upload: The add-on file being uploaded.
:form channel: (optional) The channel this version should be uploaded to,
which determines its visibility on the site. It can be either
``unlisted`` or ``listed``. See the note below.
:reqheader Content-Type: multipart/form-data
.. note::
``channel`` is only valid for new versions on existing add-ons -
if the add-on is new the version will be created as ``unlisted``. If
the parameter isn't supplied then the channel of the most recent
version (submitted either via this API or the website) will assumed.
(e.g. if you submit a version as ``listed`` then the next version will
be ``listed``, if you don't specify the channel).
``channel`` is only valid for new versions on existing add-ons.
If the add-on is new then the version will be created as ``unlisted``.
If the parameter isn't supplied then the channel of the most recent
version (submitted either via this API or the website) will be assumed.
For example, if you submit a version as ``listed`` then the next version
will be ``listed`` if you don't specify the channel.
**Response:**