Avro Schema Service

Overview

Streams can use Avro schema definitions for keys and/or values. These schemas need to be provided with every produce call. This will usually result in a relatively high overhead in data. The schemas are stored in the backend and ids are provided for these schemas. The produce call also accepts these ids. The Avro service can provide the id of a specified schema for a specific stream and environment.

API Specification

Endpoint

<baseurl>/schema/{environment}/{stream}

HTTP Method

POST

Path Variable

environment

The environment short name as specified in the Self Service definition

Path Variable

stream

The stream name as specified in the Self Service definition

Request

HTTP Header

Content-Type

application/json

HTTP Body

JSON Object

SchemaRequest

Response

HTTP Status Code

200

HTTP Header

Content-Type

application/json

HTTP Body

JSON Object

SchemaResponse

Error responses

HTTP Status Code

400

No key and no value given in request

HTTP Status Code

403

Not authorized to access the stream

HTTP Status Code

404

Schema not found for this environment and stream

HTTP Header

Content-Type

application/json

HTTP Body

JSON Object

AxualRestException