-
@serviceInfo
+ @serviceInfo @breadcrumbs.map { breadcrumbs =>
@@ -169,7 +169,6 @@
}
-
@if(leftNav.isDefined) { @contentWithLeftNav } else { @content } diff --git a/app/uk/gov/hmrc/apidocumentation/views/raml/fields.scala.html b/app/uk/gov/hmrc/apidocumentation/views/raml/fields.scala.html index 77cf0ac9..167b0ac2 100644 --- a/app/uk/gov/hmrc/apidocumentation/views/raml/fields.scala.html +++ b/app/uk/gov/hmrc/apidocumentation/views/raml/fields.scala.html @@ -19,15 +19,15 @@ @(fields: Seq[RequestResponseField], caption: String, fieldOptionalityKnown: Boolean) @if(fields.nonEmpty) { - - - + - +
+ + - - + + @@ -36,7 +36,7 @@ 0) {table__row--nested-@{field.depth}}"> - - + - + - + - +
Name
Name Description
+
@{field.name}
@if(field.isArray) {array} else {@{field.`type`}}
@@ -54,12 +54,12 @@ @if(field.description.nonEmpty) {

@{field.description}

} @field.typeId match { - case "full-date" => {

Date in the format YYYY-MM-DD

} - case "tax-year" => {

Tax year in the format YYYY-YY

} + case "full-date" => {

Date in the format YYYY-MM-DD

} + case "tax-year" => {

Tax year in the format YYYY-YY

} case _ => { @if(field.pattern.nonEmpty) {

- Must conform to the regular expression @{field.pattern} + Must conform to the regular expression @{field.pattern}

} } @@ -72,7 +72,7 @@
@for(enumValue <- field.enumValues) {
- @{enumValue.name} + @{enumValue.name} @if(enumValue.description.isDefined) { - @{enumValue.description} }
} @@ -80,7 +80,7 @@ } else { @if(field.example.nonEmpty) {

- For example: @{field.example} + For example: @{field.example}

} } diff --git a/app/uk/gov/hmrc/apidocumentation/views/raml/headers.scala.html b/app/uk/gov/hmrc/apidocumentation/views/raml/headers.scala.html index 641ad5db..869b939b 100644 --- a/app/uk/gov/hmrc/apidocumentation/views/raml/headers.scala.html +++ b/app/uk/gov/hmrc/apidocumentation/views/raml/headers.scala.html @@ -22,12 +22,12 @@ @if(headers.nonEmpty) {

@caption

- - - + - + - + - +
+ + - + diff --git a/app/uk/gov/hmrc/apidocumentation/views/raml/method_params.scala.html b/app/uk/gov/hmrc/apidocumentation/views/raml/method_params.scala.html index a072bdb1..342f7b8f 100644 --- a/app/uk/gov/hmrc/apidocumentation/views/raml/method_params.scala.html +++ b/app/uk/gov/hmrc/apidocumentation/views/raml/method_params.scala.html @@ -20,7 +20,7 @@ @for(param <- params){ - - - + + - - + +
Name Value Description
@param.name
@{param.baseTypeName}
@@ -36,12 +36,12 @@ @Markdown(param.description) @param.typeName match { - case "date" => {

Date in the format YYYY-MM-DD

} - case "taxYear" => {

Tax year in the format YYYY-YY

} + case "date" => {

Date in the format YYYY-MM-DD

} + case "taxYear" => {

Tax year in the format YYYY-YY

} case _ => { @for(pattern <- param.pattern) {

- Must conform to the regular expression @{pattern} + Must conform to the regular expression @{pattern}

} } @@ -53,12 +53,12 @@ Limited to the following possible values:

@for(enumValue <- param.enumValues) { -
@{enumValue}
+
@{enumValue}
}
} else {

- @if(Val(param.example).nonEmpty) {For example: @Val(param.example)} + @if(Val(param.example).nonEmpty) {For example: @Val(param.example)}

} diff --git a/app/uk/gov/hmrc/apidocumentation/views/raml/resource_content.scala.html b/app/uk/gov/hmrc/apidocumentation/views/raml/resource_content.scala.html index 311e6494..f6b69605 100644 --- a/app/uk/gov/hmrc/apidocumentation/views/raml/resource_content.scala.html +++ b/app/uk/gov/hmrc/apidocumentation/views/raml/resource_content.scala.html @@ -85,14 +85,14 @@

Authorisation

This resource is user-restricted - - it requires an Authorization header containing an OAuth 2.0 Bearer Token with the {scope} scope. + - it requires an Authorization header containing an OAuth 2.0 Bearer Token with the {scope} scope.

} case ("application", _) => {

This resource is application-restricted - - it requires an Authorization header containing a server_token or an OAuth 2.0 Bearer Token. + - it requires an Authorization header containing a server_token or an OAuth 2.0 Bearer Token.

} case _ => { @@ -111,7 +111,7 @@

Request

@if(example.description().isDefined){Scenario: @example.description()} @if(example.documentation().isDefined){

@Markdown(example.documentation.get)

} - 
@example.value()
+ 
@example.value()
} @@ -125,13 +125,13 @@

Request

}

Response

-

HTTP status: @HttpStatus(Val(resp.code))

+

HTTP status: @HttpStatus(Val(resp.code))

@for(body <- resp.body) { @for(example <- BodyExamples(body)) {
@if(example.description().isDefined){@example.description()} @if(example.documentation().isDefined){

@Markdown(example.documentation.get)

} - 
@example.value()
+ 
@example.value()
} } diff --git a/app/uk/gov/hmrc/apidocumentation/views/raml/resource_group.scala.html b/app/uk/gov/hmrc/apidocumentation/views/raml/resource_group.scala.html index ce38f6eb..39ba5078 100644 --- a/app/uk/gov/hmrc/apidocumentation/views/raml/resource_group.scala.html +++ b/app/uk/gov/hmrc/apidocumentation/views/raml/resource_group.scala.html @@ -49,7 +49,7 @@

@titleSection resources

@if(index == 0) {
- @res.resourcePath + @res.resourcePath
}
@@ -57,7 +57,7 @@

@titleSection resources

diff --git a/app/uk/gov/hmrc/apidocumentation/views/reference.scala.html b/app/uk/gov/hmrc/apidocumentation/views/reference.scala.html index f8bb1c77..91bc2e5c 100644 --- a/app/uk/gov/hmrc/apidocumentation/views/reference.scala.html +++ b/app/uk/gov/hmrc/apidocumentation/views/reference.scala.html @@ -50,7 +50,7 @@
-
+
@@ -71,11 +71,13 @@

Network access

access in your proxy, not your firewall.

Configure your proxy to allow full access to the following domains, including HTTP GET, POST, PUT and DELETE.

For testing in sandbox:

- 
test-api.service.hmrc.gov.uk
- 
test-www.tax.service.gov.uk
+ 
+test-api.service.hmrc.gov.uk
+test-www.tax.service.gov.uk

For production use:

- 
api.service.hmrc.gov.uk
- 
www.tax.service.gov.uk
+ 
+api.service.hmrc.gov.uk
+www.tax.service.gov.uk
@@ -150,17 +152,18 @@

Common API Errors
codestringcodestring A machine-readable error code. This is unique for each error scenario.
messagestringmessagestring A human-readable explanation for the error.
+

There might be other error-specific information (such as a list of fields that are in error). For example:

{
   "code" : "ACCOUNT_SUSPENDEDSA-100201",
@@ -171,20 +174,20 @@ 
Common API Errors

             
Multiple errors can also be returned in a single field called errors. For example:

             
 {
-    "code": "BAD_REQUEST",
-    "message": "Bad request",
-    "errors": [
-       {
-          "code": "MISSING_FIELD",
-          "message": "This field is required",
-          "path": "/firstName"
-       },
-       {
-          "code": "INVALID_DATE",
-          "message": "Date is invalid",
-          "path": "/dateOfBirth"
-       }
-    ]
+  "code": "BAD_REQUEST",
+  "message": "Bad request",
+  "errors": [
+    {
+      "code": "MISSING_FIELD",
+      "message": "This field is required",
+      "path": "/firstName"
+    },
+    {
+      "code": "INVALID_DATE",
+      "message": "Date is invalid",
+      "path": "/dateOfBirth"
+    }
+  ]
 }
 

             
Here is an example error response in XML format

@@ -209,19 +212,19 @@ 
401 (Unauthorized)
No OAuth token supplied for user-restricted or application-restricted resourceMISSING_CREDENTIALSMISSING_CREDENTIALS
Invalid OAuth token supplied for user-restricted or application-restricted resource (including expired token)INVALID_CREDENTIALSINVALID_CREDENTIALS
Supplied OAuth token not authorised to access data for given tax identifier(s)UNAUTHORIZEDUNAUTHORIZED
User-restricted API is being accessed with a server tokenINCORRECT_ACCESS_TOKEN_TYPEINCORRECT_ACCESS_TOKEN_TYPE
@@ -238,19 +241,19 @@

403 (Forbidden)
Request done with HTTPHTTPS_REQUIREDHTTPS_REQUIRED
Production tokens used for Beta APIAPI_NOT_IN_PRODUCTIONAPI_NOT_IN_PRODUCTION
The OAuth token's application is not subscribed to the APIRESOURCE_FORBIDDENRESOURCE_FORBIDDEN
The scope of the OAuth token is not sufficient to access the APIINVALID_SCOPEINVALID_SCOPE
@@ -268,11 +271,11 @@

404 (Not Found)
No endpoint could be found in the API for the request pathMATCHING_RESOURCE_NOT_FOUNDMATCHING_RESOURCE_NOT_FOUND
No API could be found for the contextNOT_FOUNDNOT_FOUND
@@ -290,7 +293,7 @@

405 (Method Not Allowed)

Request method is not GET, PUT, POST, DELETE or OPTIONS - METHOD_NOT_ALLOWED + METHOD_NOT_ALLOWED @@ -307,7 +310,7 @@

406 (Not Acceptable)

Missing or invalid Accept header - ACCEPT_HEADER_INVALID + ACCEPT_HEADER_INVALID @@ -324,7 +327,7 @@

429 (Too Many Requests)

The application has reached its maximum rate limit - MESSAGE_THROTTLED_OUT + MESSAGE_THROTTLED_OUT @@ -341,7 +344,7 @@

500 (Internal Server Error)

Internal server error - INTERNAL_SERVER_ERROR + INTERNAL_SERVER_ERROR @@ -358,7 +361,7 @@

501 (Not Implemented)

API not implemented/deployed - NOT_IMPLEMENTED + NOT_IMPLEMENTED @@ -375,11 +378,11 @@

503 (Service Unavailable)

Service unavailable - SERVER_ERROR + SERVER_ERROR Scheduled maintenance - SCHEDULED_MAINTENANCE + SCHEDULED_MAINTENANCE @@ -396,12 +399,13 @@

504 (Gateway Timeout)

Request timed out - GATEWAY_TIMEOUT + GATEWAY_TIMEOUT