search

mozilla / http-observatory

Mozilla HTTP Observatory
https://observatory.mozilla.org/
Mozilla Public License 2.0
1.85k stars 168 forks source link

Update API docs definition & availability #445

Closed async-costelo closed 2 years ago

async-costelo commented 3 years ago

As a fellow user of the API, and as a reader of this document, just found some inaccuracy since it last updated.

  1. There's a deprecated API route from httpobs/website/api.py L150-L56, confirmed via the comment provided. And it's responsible for Retrieve scanner states endpoint. Just want to add a deprecated label to it, and strikethrough, for users not waste their time waiting for a GATEWAY_TIMEOUT anymore. 😄

  2. Updated definition of Retrieve host's scan history, since it's the same as Retrieve recent scans, however, the object linked is different(no probs). Just updated its definition based on its response and behavior.

Macleykun commented 2 years ago

Is there a different API to initiate a rescan on the observatory from mozilla online?

Reason is that the shield.io goes back to a pending state, until manually a rescan is done.

gene1wood commented 2 years ago

@async-costelo Thanks! Would you update this PR and remove the many changes from the markdown bullet lists from * to -? Difficult to see the actual change in the PR and using * is fine for markdown lists.

async-costelo commented 2 years ago

@gene1wood Apologies, my vscode actually auto formatted those changes. Here's a cleaner PR instead -> https://github.com/mozilla/http-observatory/pull/453