New in version 2.

Langpacks

Currently in development, subject to change. Follow https://bugzilla.mozilla.org/show_bug.cgi?id=1105530 for more information.

List

GET /api/v2/langpacks/

Returns a list of active langpacks.

Request

The standard Listing query params.

If the request is authenticated and the user has the LangPacks:% permission, then the following additional parameters are accepted:

Parameters:
  • active (string) – a flag indicating whether the response should include inactive langpacks or not. Pass active=null to show all langpacks regardless of their active status, and pass active=false to only show inactive langpacks.

Response

Parameters:

Detail

GET /api/v2/langpacks/(string: uuid)/

Returns a single langpack. If the request is authenticated and the user has the LangPacks:% permission, inactive langpacks can be returned.

Response

Parameters:
  • active (string) – A boolean representing the langpack state. Inactive langpacks are hidden by default.
  • created (string) – The date that the langpack was first uploaded (in ISO 8601 format).
  • fxos_version (string) – The Firefox OS version this langpack provides translations for.
  • language (string) – The language code (i.e. “de”, or “pt-BR”) this langpack provides translations for.
  • language_display (string) – The language this langpack provides translations for, in a human-readable format (i.e. Deutsch).
  • manifest_url – The URL to the mini-manifest for this package, which contains everything needed to install and update the language pack.
  • modified (string) – The date that the langpack was last modified (in ISO 8601 format).
  • uuid (string) – Unique identifier for this langpack.
  • version (string) – The version of the Langpack package itself.

Langpack properties edition

PATCH /api/v2/langpacks/(string: uuid)/

Note

Requires authentication and the LangPacks:% permission.

Parameters:
  • active (boolean) – A boolean representing the langpack state. Inactive langpacks are hidden by default.

Deletion

DELETE /api/v2/langpacks/(string: uuid)/

Note

Requires authentication and the LangPacks:% permission.

Creation

To upload a new langpack, the process is similar to app submission. First you need to upload your package to the validation endpoint, and then, once the package has been validated, you can use the validation id in the endpoints below:

POST /api/v2/langpacks/

Note

Requires authentication and the LangPacks:% permission.

Note

By default, langpacks are created inactive. Once everything looks ok, use the patch API to activate a langpack.

Parameters:
  • upload (string) – Validation id.

Package update

PUT /api/v2/langpacks/(string: uuid)/

Note

Requires authentication and the LangPacks:% permission.

Parameters:
  • upload (string) – Validation id.