rest

Documentation

Overview

Package rest implements a REST data source.

The REST data source is a data source that can be used to fetch data from a REST API. The data source is defined in the Minder API as a REST data source definition. The definition contains a set of handlers that define how to fetch data from the REST API.

It gives the caller a simple structured output to represent the result of the REST call.

An example of the output is:

{
  "status_code": 200,
  "body": {
    "key": "value"
  }
}

Index

• Constants
• func NewRestDataSource(rest *minderv1.RestDataSource) (v1datasources.DataSource, error)

Constants

const (
	// MaxBytesLimit is the maximum number of bytes to read from the response body
	// We limit to 1MB to prevent abuse
	MaxBytesLimit int64 = 1 << 20
)

Functions

func NewRestDataSource

func NewRestDataSource(rest *minderv1.RestDataSource) (v1datasources.DataSource, error)

NewRestDataSource builds a new REST data source.