Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

ServiceTestAnswer

A service's Test: passed, with the milliseconds the service took to answer (Overture: how many releases its listing names and the newest; templates: how many templates the catalogue's index lists, with the milliseconds), or failed with one reason: not_set_up (no address), refused (the egress rules refused it, or the satellite tile template carries a user name or password; message is the refusal's sentence), unreachable (nothing answered), timed_out (no answer within the service's time limit), status (an answer with that status) or unexpected_answer (an answer, but not as the service gives one). Never the service's body, its address or a key.

One of:

  • object

    • servicestringrequired

      One of geocode, isochrone, overpass, s3, satellite

    • resultalways passedrequired

    • millisecondsintegerrequiredminimum 0

      How long the service took to answer, once the request was sent.

    No other keys.

  • object

    • servicealways templatesrequired

    • resultalways passedrequired

    • templatesintegerrequiredminimum 0

      How many templates the catalogue's index lists that this server reads.

    • millisecondsintegerrequiredminimum 0

      How long the catalogue took to answer with its index, once the request was sent.

    No other keys.

  • object

    • servicealways overturerequired

    • resultalways passedrequired

    • releasesintegerrequiredminimum 1

      How many releases the listing names; kept as the list the Overture pane offers.

    • neweststringrequired

      The newest release.

    No other keys.

  • object

    • servicestringrequired

      The service tested.

      One of geocode, isochrone, overpass, overture, s3, satellite, templates

    • resultalways failedrequired

    • reasonalways refusedrequired

    • messagestringrequired

      The refusal's sentence: the egress check's, or the one a save refuses a satellite tile template carrying a user name or password with.

    No other keys.

  • object

    • servicestringrequired

      The service tested.

      One of geocode, isochrone, overpass, overture, s3, satellite, templates

    • resultalways failedrequired

    • reasonalways statusrequired

    • statusintegerrequiredminimum 100maximum 599

      The status the service answered with.

    No other keys.

  • object

    • servicestringrequired

      The service tested.

      One of geocode, isochrone, overpass, overture, s3, satellite, templates

    • resultalways failedrequired

    • reasonstringrequired

      One of not_set_up, unreachable, timed_out, unexpected_answer

    No other keys.

Dezfil · Apache-2.0docs from 7439201b