Access Management: Group Operations8

Access Management: Role Operations6

Access Management: User Operations6

Account Operations7

Cell Operations1

Connection Operations9

Data Plane Tokens11

Declarative Operations2

Files1

Pipeline Operations17

Preview Operations1

Schema Operations1

Secret Operations5

Stream Operations7

Tasks Operations1

Stream Operations

Check if a given schema is compatible with a stream.

Requires permission matching: stream:read:default.<name>.

post/streams/{id}/compatibility

Request

Base URL
https://replace-with-account.api.decodable.co/v1alpha2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
  Token URLhttps://auth.decodable.co/oauth/token
  Scopeswrite:preview
TypeScript
https://skmtc.dev/decodable/apis/decodable-control-plane/docs/streams/:id/compatibility/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

OR

Response

A stream compatibility response.

compatibleboolean required

if the request schema is compatible

errorstring

error message if the schema is not compatible

Changes

No recorded changes to this operation across all 1 revision of this API.