From d885b1bf5839fa143f9fc2c50ae7c2f789dbb05f Mon Sep 17 00:00:00 2001 From: Joshua Mendoza Date: Wed, 11 Oct 2023 12:17:01 -0600 Subject: [PATCH 1/4] Add Authentication section at the top of the API page --- docs/source/api.rst | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index f6e7b87..a44a6c9 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -7,10 +7,32 @@ API Overview -------- - .. _authentication: +.. _authentication: + +Authentication +-------------- + +All requests to the Modeling API must include authentication credentials. + +API access tokens are applied to your requests to protect sensitive PII and are compliant with common privacy and security standards. + +A valid token must be included as part of the HTTP Authorization header, using the `bearer` HTTP authorization scheme. The value of the header will be ``Bearer ``, where you replace with a valid token. Valid tokens will be provided to established customers of the API. It is planned to add the ability to rotate tokens and set expiration dates in future releases. + +.. code-block:: + + Authorization: Bearer + + +Here is an example using cURL: + +.. code-block:: shell + + curl -v 'https://api.radiantlabs.co/v1/timelines' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + --data-raw '{"addressFull":"501 RANDALL RD, BALLSTON SPA, NY 12020"}' \ + --compressed - Authentication - -------------- .. _endpoints: From 74c578a7ef526560a627185e30d6f81dfba33613 Mon Sep 17 00:00:00 2001 From: Joshua Mendoza Date: Wed, 11 Oct 2023 12:21:41 -0600 Subject: [PATCH 2/4] Manually add sphinx-rtd-theme dependency --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index d0c9eda..a8ca190 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ # Extra packages -sphinx-copybutton # 2023-05-03 - Joshua: Added for easy code blocks copying \ No newline at end of file +sphinx-copybutton # 2023-05-03 - Joshua: Added for easy code blocks copying +sphinx-rtd-theme # 2023-10-11 - Joshua: For some reason, RTD automatic builds won't include this package From 8de74f9adb61e1ac2be1657b32cd0d6337b1a0b9 Mon Sep 17 00:00:00 2001 From: Joshua Mendoza Date: Wed, 11 Oct 2023 12:25:39 -0600 Subject: [PATCH 3/4] Pin dependency versions --- docs/requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index a8ca190..1f7a8e9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ # Extra packages -sphinx-copybutton # 2023-05-03 - Joshua: Added for easy code blocks copying -sphinx-rtd-theme # 2023-10-11 - Joshua: For some reason, RTD automatic builds won't include this package +sphinx-copybutton == 0.5.2 # 2023-05-03 - Joshua: Added for easy code blocks copying +sphinx-rtd-theme == 1.3.0 # 2023-10-11 - Joshua: For some reason, RTD automatic builds won't include this package From 63ef3994398298a1a14158aeba586223089eea77 Mon Sep 17 00:00:00 2001 From: Joshua Mendoza Date: Wed, 11 Oct 2023 12:28:49 -0600 Subject: [PATCH 4/4] Improve formatting --- docs/source/api.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index a44a6c9..3552a56 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -16,7 +16,7 @@ All requests to the Modeling API must include authentication credentials. API access tokens are applied to your requests to protect sensitive PII and are compliant with common privacy and security standards. -A valid token must be included as part of the HTTP Authorization header, using the `bearer` HTTP authorization scheme. The value of the header will be ``Bearer ``, where you replace with a valid token. Valid tokens will be provided to established customers of the API. It is planned to add the ability to rotate tokens and set expiration dates in future releases. +A valid token must be included as part of the HTTP ``Authorization`` header, using the `bearer` HTTP authorization scheme. The value of the header will be ``Bearer ``, where you replace with a valid token. Valid tokens will be provided to established customers of the API. It is planned to add the ability to rotate tokens and set expiration dates in future releases. .. code-block:: @@ -29,7 +29,7 @@ Here is an example using cURL: curl -v 'https://api.radiantlabs.co/v1/timelines' \ -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer ' \ + -H 'Authorization: Bearer ' \ --data-raw '{"addressFull":"501 RANDALL RD, BALLSTON SPA, NY 12020"}' \ --compressed