HookSniffAPI.Api.Schemas (HookSniff v0.3.0)

Copy Markdown View Source

API calls for all endpoints tagged Schemas.

Summary

Functions

schemas_get(connection, opts \\ [])

List registered schemas

schemas_id_get(connection, id, opts \\ [])

Get schema by ID

schemas_id_validate_post(connection, id, validate_event_request, opts \\ [])

Validate an event against a schema

schemas_post(connection, register_schema_request, opts \\ [])

Register a new JSON Schema

Functions

schemas_get(connection, opts \\ [])

@spec schemas_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

List registered schemas

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

schemas_id_get(connection, id, opts \\ [])

@spec schemas_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get schema by ID

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

schemas_id_validate_post(connection, id, validate_event_request, opts \\ [])

@spec schemas_id_validate_post(
  Tesla.Env.client(),
  String.t(),
  HookSniffAPI.Model.ValidateEventRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Validate an event against a schema

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • id (String.t):
  • validate_event_request (ValidateEventRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

schemas_post(connection, register_schema_request, opts \\ [])

@spec schemas_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.RegisterSchemaRequest.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Register a new JSON Schema

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • register_schema_request (RegisterSchemaRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure