This document describes the Examples Documentation Asciidoctor Validation.

1. Micro Service

1.1. PUT /

1.1.1. Request

1.1.1.1. HTTP Request Example
PUT / HTTP/1.1
Accept: application/json
Content-Type: application/json
Content-Length: 28

{
  "phone": "12254359430"
}
1.1.1.2. HTTP Request Body Parameters Description

Name

Type

Restrictions

Description

phone

string

  • required: true

  • format: phone number

Phone number in the international format.

1.1.1.3. HTTP Request Body JSON Schema
{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "phone": {
      "type": "string",
      "format": "phone",
      "examples": [
        "12254359430"
      ]
    }
  },
  "required": [
    "phone"
  ],
  "minProperties": 1,
  "maxProperties": 1
}

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 400

If current request contains validation error.

1.1.3.1. HTTP Response Example
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 34
Request-Id: 62jJeu8x1310662

{
  "message": "Invalid Request"
}
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:
1.1.3.3. HTTP Response Body Parameters Description

Name

Type

Restrictions

Description

message

string

  • required: true

The detailed cause of the arisen validation error.

1.1.4. Response 500

If internal server error detected.

1.1.4.1. HTTP Response Example
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 33
Request-Id: 62jJeu8x1310662

{
  "message": "Internal Error"
}
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

message

string

  • required: true

Internal Server Error value (by default) or the detailed cause of the arisen internal server error.