Skip to content

Commit

Permalink
removed outdated copy
Browse files Browse the repository at this point in the history
  • Loading branch information
argl committed Oct 11, 2024
1 parent 7e75d47 commit a7ef41f
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions copy/observatory/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,11 @@ The MDN team has:

## Has the HTTP Observatory API been updated to use the new tests?

~~Not yet. The API will continue using the old test infrastructure for a while,
therefore you will see some small differences between test scores returned by
the API and the website. The API will be updated to use the new tests in a
near-future iteration.~~

Yes. The new v2 API is available at an updated URL — `https://observatory-api.mdn.mozilla.net/api/v2/scan` — and the
response is now more concise. For example, a [`POST`](/en-US/docs/Web/HTTP/Methods/POST) request to
`https://observatory-api.mdn.mozilla.net/api/v2/scan?host=mdn.net` will return a
JSON payload like this:
Yes. The new v2 API is available at an updated URL —
`https://observatory-api.mdn.mozilla.net/api/v2/scan` — and the response is now
more concise. For example, a [`POST`](/en-US/docs/Web/HTTP/Methods/POST) request
to `https://observatory-api.mdn.mozilla.net/api/v2/scan?host=mdn.net` will
return a JSON payload like this:

```json
{
Expand All @@ -121,8 +117,8 @@ JSON payload like this:
}
```

We have removed several fields that were of limited use for CI integration,
like the complete response header listing. The important metrics like `score` and
We have removed several fields that were of limited use for CI integration, like
the complete response header listing. The important metrics like `score` and
`grade` are still included. We encourage you to migrate to the new API as soon
as possible: The v1 endpoint will be shut down on October 31, 2024.

Expand All @@ -137,7 +133,7 @@ For reference, the v1 API returned a JSON payload with the following structure:
"likelihood_indicator": "LOW",
"response_headers": {
"Accept-Ranges": "none",
...
"Another-Header": "another-value"
},
"scan_id": 56728847,
"score": 100,
Expand Down

0 comments on commit a7ef41f

Please sign in to comment.