Hello world

GET 
/api/examples/hello

Return a greeting message

Request

Query Parameters

text Text

Default value: hello

Header Parameters

x-correlation-id X-Correlation-Id

Correlation ID is a special type of request ID which is unique over a series of requests and responses, identifying a transaction in a distributed system. Correlation ID will be generated if not provided.

x-request-id X-Request-Id

In distributed system architecture (microservices architecture) it is a unique ID of a request and response combination throughout all components of the system. Request ID will be generated if not provided.

Responses

200

Successful Response

application/json

Schema

Schema

text Text (string)required

Example (from schema)

{
  "text": "string"
}

400

Request payload data was invalid and could not be parsed.

application/json

Schema

Schema

type ErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.invalid, request.content-length-missing, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded]

Types of errors that can occur during request handling.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional detail of the error. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request.invalid

Invalid request.

{
  "type": "request.invalid",
  "message": "Invalid request.",
  "detail": []
}

422

Error during validation of request payload data occurred.

application/json

Schema

Schema

type ErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.invalid, request.content-length-missing, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded]

Types of errors that can occur during request handling.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional detail of the error. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request validation error

Request validation error.

{
  "type": "request.validation-error",
  "message": "Request validation error.",
  "detail": []
}

429

Request rate limit exceeded.

The request may be retried after a while. The following response headers may be checked for details: retry-after, x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset.

Response Headers

• retry-after

  number

  Header indicates how long the user agent should wait before making a follow-up request.

• x-ratelimit-limit

  number

  Maximum number of requests which is allowed in the currently used rate limiting window.

• x-ratelimit-remaining

  number

  Remaining number of requests in the currently used rate limiting window.

• x-ratelimit-reset

  number

  Time at which the current rate limiting window resets (in UTC epoch).

application/json

Schema

Schema

type ErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.invalid, request.content-length-missing, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded]

Types of errors that can occur during request handling.

message Message (string)required

Human-readable summary of the error.

detail

object[]

Optional detail of the error. It is intended for better understanding of the error or advanced error handling.

Array [

location

object[]

required

Location of the error.

Array [

anyOf

MOD1

integer

MOD2

string

]

message Message (string)required

Human-readable summary of the error.

type Type (string)required

Machine-readable error type.

context

object

Optional key-value object with additional context

property name*

object

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD5

Array [

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

]

]

Example (from schema)

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

request.rate-limit-exceeded

Rate limit exceeded.

{
  "type": "request.rate-limit-exceeded",
  "message": "Rate limit exceeded: 1 per 5 second.",
  "detail": []
}

Loading...