From 8bb7555852025d96478e393423ab29e11f9cf986 Mon Sep 17 00:00:00 2001 From: Marek Isalski Date: Fri, 6 Oct 2023 09:20:42 +0000 Subject: [PATCH] formatting --- Connectivity.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/Connectivity.md b/Connectivity.md index 645d80a..95070ad 100644 --- a/Connectivity.md +++ b/Connectivity.md @@ -5,7 +5,9 @@ X-Api-Key: d588a0d0-ed0a-4d2d-b6d8-c3bf6fbe7f20 Accept: application/json ``` -## `GET https://api.faelix.net/connectivity/xdsl/address/search/?postcode=M219WR` +## Availability Check + +### `GET https://api.faelix.net/connectivity/xdsl/address/search/?postcode=M219WR` ```json { @@ -30,7 +32,7 @@ Accept: application/json } ``` -## `GET https://api.faelix.net/connectivity/xdsl/address/service/availability/?reference=A00034156395&district=MR` +### `GET https://api.faelix.net/connectivity/xdsl/address/service/availability/?reference=A00034156395&district=MR` ```json ```json @@ -48,7 +50,7 @@ Accept: application/json } ``` -## `GET https://api.faelix.net/connectivity/xdsl/line/service/availability/?cli=01618629595` +### `GET https://api.faelix.net/connectivity/xdsl/line/service/availability/?cli=01618629595` ```json { @@ -282,7 +284,9 @@ Accept: application/json } ``` -## `GET https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/available` +## Testing Lines + +### `GET https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/available` Returns a dict mapping test types to information about the tests. Will only return tests available for that type of line. @@ -298,7 +302,7 @@ Returns a dict mapping test types to information about the tests. Will only ret } ``` -## `POST https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xxxx-service-test` +### `POST https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xxxx-service-test` Starts a test, and returns a redirect (via `Location: ` header) where you can then `GET` the results. @@ -310,7 +314,7 @@ Location: https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xx } ``` -## `GET https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xxxx-service-test/result/beeb411e-d15b-43db-810c-b850fa123253` +### `GET https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xxxx-service-test/result/beeb411e-d15b-43db-810c-b850fa123253` Returns a blob of raw JSON test results. Will be different for different test types. Not a valid result (yet) if the `dataFrom` key has no value associated.