From ab5a6cd7dcea067c6b9e585a4b50e3f8d301d181 Mon Sep 17 00:00:00 2001 From: Emma Beynon Date: Thu, 21 Sep 2017 14:03:54 +0100 Subject: [PATCH 1/3] Add comma in HTTPS section --- source/index.html.md.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.html.md.erb b/source/index.html.md.erb index 3821bda..bea273b 100644 --- a/source/index.html.md.erb +++ b/source/index.html.md.erb @@ -109,7 +109,7 @@ Please don’t disclose the suspected breach publicly until it has been fixed. GOV.UK Content API follows government HTTPS security guidelines. The Hypertext Transfer Protocol Secure (HTTPS), which involves the Transport Layer -Security (TLS) protocol is used by the platform to provide secure connections. +Security (TLS) protocol, is used by the platform to provide secure connections. ### Security patches From a72d4458c740e1deb33930e494bfa7d4b27304ee Mon Sep 17 00:00:00 2001 From: Emma Beynon Date: Thu, 21 Sep 2017 14:05:55 +0100 Subject: [PATCH 2/3] Replace hyphen with comma in Getting Started --- source/getting-started.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started.html.md b/source/getting-started.html.md index 7df96dd..3408052 100644 --- a/source/getting-started.html.md +++ b/source/getting-started.html.md @@ -7,7 +7,7 @@ title: Getting Started This guide introduces a number of key concepts in GOV.UK Content API through the usage of examples. It utilises [curl](https://curl.haxx.se/) for interfacing with the API on the command line and is chosen due to the wide -availability of curl- however you may prefer the structured output of +availability of curl, however you may prefer the structured output of using [HTTPie](https://httpie.org/) or piping the curl responses through [jq](https://stedolan.github.io/jq/). From 5a2325c00559fb0f48854dc36e3819c91c150bc2 Mon Sep 17 00:00:00 2001 From: Emma Beynon Date: Thu, 21 Sep 2017 14:08:49 +0100 Subject: [PATCH 3/3] Capitalize VAT --- source/getting-started.html.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/getting-started.html.md b/source/getting-started.html.md index 3408052..773deff 100644 --- a/source/getting-started.html.md +++ b/source/getting-started.html.md @@ -66,7 +66,7 @@ The `schema_name` refers to a file referenced in the name of the format on GOV.UK. Often these fields share the same value as there is often only one schema for a particular `document_type`. -This is the case with [Vat Rates][vat-rates-api] where the content returned +This is the case with [VAT Rates][vat-rates-api] where the content returned utilises the [`answer` schema][answer-schema]. ### Details @@ -87,7 +87,7 @@ contains data in a particular structure relevant for the type of content. This structure is described by the [schema](#document-type-and-schema-name), which itself is defined by the `schema_name` field. -In the case of [Vat Rates][vat-rates-api] an [`answer` schema][answer-schema] +In the case of [VAT Rates][vat-rates-api] an [`answer` schema][answer-schema] is used. The `answer` schema allows a `body` value, which contains the HTML for the page and a `external_related_links` value, which is an array that can be used to provide links to associated pages hosted off GOV.UK. @@ -102,7 +102,7 @@ value represents an array of [`LinkedContentItems`][linked-content-item]. A The values that can be used for link types are defined within the [schema](#document-type-and-schema-name) associated with the content. This value describes the type of relationship between content. For example, -with [Vat Rates][vat-rates-api] there is a relationship with a link type of +with [VAT Rates][vat-rates-api] there is a relationship with a link type of `mainstream_browse_pages`. The purpose of this link type is to enable linking to pages to help users find similar content that is suitable for a mainstream audience.