Document need for v=4 param on telemetry submissions (#575)

This commit is contained in:
Jeff Klukas 2020-10-20 16:23:44 -04:00 коммит произвёл GitHub
Родитель 6d2545b8d9
Коммит 3f61a86999
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 4 добавлений и 2 удалений

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

@ -58,15 +58,17 @@ will be considered an error and will not proceed to the data lake.
Firefox Desktop Telemetry uses a slightly different URL scheme:
`/submit/telemetry/docId/docType/appName/appVersion/appUpdateChannel/appBuildID`
`/submit/telemetry/docId/docType/appName/appVersion/appUpdateChannel/appBuildID?v=4`
A specific example:
`/submit/telemetry/ce39b608-f595-4c69-b6a6-f7a436604648/main/Firefox/61.0a1/nightly/20180328030202`
`/submit/telemetry/ce39b608-f595-4c69-b6a6-f7a436604648/main/Firefox/61.0a1/nightly/20180328030202?v=4`
Here the `namespace` is fixed as "telemetry", and there is no `docVersion` in the URL.
This means that incoming JSON documents must be parsed to determine the schema version
to apply for validation. This logic is part of the downstream [decoder] job.
Also note the required query parameter suffix `?v=4`.
Documents sent under `/submit/telemetry` without `v=4` will be rejected at the edge.
### POST/PUT Response codes