From fce4a3663616fce309dcc53bbf9ac14e37f9b554 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Mon, 23 Sep 2019 17:01:59 +0100 Subject: [PATCH 1/4] Update content --- app/templates/views/documentation.html | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 82151f7ba..e5bd12947 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -23,12 +23,8 @@ {% endfor %}

A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you’re using.

-

Integrating directly with the API

-

We recommend using the client libraries rather than integrating directly with the API.

-

There’s no documentation for using the API in this way. You’ll still need to read the client documentation to understand:

- -

To send a message you’ll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

+

Integrate directly with the API

+

If you cannot use the client libraries, you can integrate directly with the API instead.

+

Read the REST API documentation.

+ {% endblock %} From 7bdcf7414d7f6733b304e8bab9f6f2852173e647 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Mon, 23 Sep 2019 17:05:02 +0100 Subject: [PATCH 2/4] Add 'link opens in new tab' explanation --- app/templates/views/documentation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index e5bd12947..4ca82c667 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -25,6 +25,6 @@

A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you’re using.

Integrate directly with the API

If you cannot use the client libraries, you can integrate directly with the API instead.

-

Read the REST API documentation.

+

Read the REST API documentation (this link opens in a new tab).

{% endblock %} From d902ac3b440535c9bcd8b2a0d0c4f8327be45a50 Mon Sep 17 00:00:00 2001 From: Rebecca Law Date: Wed, 25 Sep 2019 15:47:35 +0100 Subject: [PATCH 3/4] Added the url for api docs. Updated error message when js tests fail --- app/templates/views/documentation.html | 2 +- scripts/run_tests.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 4ca82c667..ba1b5f0ea 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -25,6 +25,6 @@

A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you’re using.

Integrate directly with the API

If you cannot use the client libraries, you can integrate directly with the API instead.

-

Read the REST API documentation (this link opens in a new tab).

+

Read the REST API documentation (this link opens in a new tab).

{% endblock %} diff --git a/scripts/run_tests.sh b/scripts/run_tests.sh index 47994032e..0ab2f9c55 100755 --- a/scripts/run_tests.sh +++ b/scripts/run_tests.sh @@ -34,7 +34,7 @@ isort --check-only -rc ./app ./tests display_result $? 2 "Import order check" npm test -display_result $? 3 "Front end code style check" +display_result $? 3 "Javascript test have failed" ## Code coverage py.test -n auto --maxfail=10 --cov=app --cov-report=term-missing tests/ --junitxml=test_results.xml --strict -p no:warnings From 0bd844a961936f8f7eb8342cfc60983655d46765 Mon Sep 17 00:00:00 2001 From: Rebecca Law Date: Wed, 25 Sep 2019 16:09:36 +0100 Subject: [PATCH 4/4] Update puralisation --- scripts/run_tests.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/run_tests.sh b/scripts/run_tests.sh index 0ab2f9c55..960824a12 100755 --- a/scripts/run_tests.sh +++ b/scripts/run_tests.sh @@ -34,7 +34,7 @@ isort --check-only -rc ./app ./tests display_result $? 2 "Import order check" npm test -display_result $? 3 "Javascript test have failed" +display_result $? 3 "Javascript tests have failed" ## Code coverage py.test -n auto --maxfail=10 --cov=app --cov-report=term-missing tests/ --junitxml=test_results.xml --strict -p no:warnings