This document describes the Examples Documentation Asciidoctor Errors.

1. Complex Micro Service

1.1. GET /

1.1.1. Request

1.1.1.1. HTTP Request Example
GET / HTTP/1.1
Accept: application/json
Content-Length: 0

1.1.2. Response 200

1.1.2.1. HTTP Response Example
HTTP/1.1 200 OK
Content-Length: 0
Request-Id: 62jJeu8x1310662

1.1.3. Response 429

Too Many Requests

1.1.3.1. HTTP Response Example
HTTP/1.1 429 Too Many Requests
Content-Length: 0
Request-Id: 62jJeu8x1310662
Retry-After: 3600
1.1.3.2. HTTP Response Headers Description

Name

Type

Restrictions

Description

Request-Id

string

  • required: true

  • unique: true

An unique request string identifier.

Read more:

Retry-After

number

  • optional: true

Indicates how long to wait before making a new request.

1.1.4. Response 499

CustomWithInternalsException description!

1.1.4.1. HTTP Response Example
HTTP/1.1 499
Content-Type: application/json
Content-Length: 3
Request-Id: 62jJeu8x1310662

{
}
1.1.4.2. HTTP Response Headers Description

Name

Type

Restrictions

Description

Request-Id

string

  • required: true

  • unique: true

An unique request string identifier.

Read more:
1.1.4.3. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

1.1.5. Response 500

Internal Server Error

1.1.5.1. HTTP Response Example
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 91
Request-Id: 62jJeu8x1310662
Retry-After: 3600

{
  "message": "NullPointerException",
  "readMore": "https://example.com/read-more.html"
}
1.1.5.2. HTTP Response Headers Description

Name

Type

Restrictions

Description

Request-Id

string

  • required: true

  • unique: true

An unique request string identifier.

Read more:

Retry-After

number

  • optional: true

Indicates how long to wait before making a new request.
1.1.5.3. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

message

string

  • required: true

The detailed cause of error

readMore

string

  • optional: true

'readMore' parameter

2. Proxy Micro Service

2.1. GET /

2.1.1. Request

2.1.1.1. HTTP Request Example
GET / HTTP/1.1
Accept: application/json
Content-Length: 0

2.1.2. Response 200

2.1.2.1. HTTP Response Example
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 22
Request-Id: 62jJeu8x1310662

{
  "data": "string"
}
2.1.2.2. HTTP Response Headers Description

Name

Type

Restrictions

Description

Request-Id

string

  • required: true

  • unique: true

An unique request string identifier.

Read more:
2.1.2.3. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

data

string

  • required: true
2.1.2.4. HTTP Response Body JSON Schema

(Read more about JSON Schema)

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "examples": [
        "string"
      ]
    }
  },
  "required": [
    "data"
  ],
  "minProperties": 1,
  "maxProperties": 1
}

2.1.3. Response 404

If data not found

2.1.3.1. HTTP Response Example
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 34
Request-Id: 62jJeu8x1310662

{
  "message": "Data not found!"
}
2.1.3.2. HTTP Response Headers Description

Name

Type

Restrictions

Description

Request-Id

string

  • required: true

  • unique: true

An unique request string identifier.

Read more:
2.1.3.3. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

message

string

  • required: true

'message' parameter

2.1.4. Response 406

This error response indicates that the API is not able to generate any of the client’s preferred media types, as indicated by the Accept request header.

2.1.4.1. HTTP Response Example
HTTP/1.1 406 Not Acceptable
Content-Type: application/json
Content-Length: 33
Request-Id: 62jJeu8x1310662

{
  "message": "Not-Acceptable"
}
2.1.4.2. HTTP Response Headers Description

Name

Type

Restrictions

Description

Request-Id

string

  • required: true

  • unique: true

An unique request string identifier.

Read more:
2.1.4.3. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

message

string

  • required: true

The detailed cause of the arisen error.

2.1.5. Response 410

Custom description

2.1.5.1. HTTP Response Example
HTTP/1.1 410 Gone
Content-Type: application/json
Content-Length: 54
Request-Id: 62jJeu8x1310662

{
  "next_attempt_after": "2187-04-10T23:40:15.789Z"
}
2.1.5.2. HTTP Response Headers Description

Name

Type

Restrictions

Description

Request-Id

string

  • required: true

  • unique: true

An unique request string identifier.

Read more:

Debug

boolean

  • optional: true

Debug header example description
2.1.5.3. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

next_attempt_after

string

  • required: true

  • format: UTC

  • future: true

The client must repeat some action after this instant

Read more:

2.1.6. Response 504

If response is not received within a specified time period.

2.1.6.1. HTTP Response Example
HTTP/1.1 504 Gateway Timeout
Content-Type: application/json
Content-Length: 34
Request-Id: 62jJeu8x1310662

{
  "message": "Request Timeout"
}
2.1.6.2. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

message

string

  • required: true

Gateway Timeout value (by default) or contains external rest micro service endpoint, which is not available now.