logtypesapi

Documentation

Overview

Code generated by apigen; DO NOT EDIT. package logtypesapi documents github.com/panther-labs/panther/internal/core/logtypesapi.LogTypesAPI

Index

• type DelCustomLogInput
• type DelCustomLogResponse
• type GetCustomLogInput
• type GetCustomLogResponse
• type ListAvailableLogTypesResponse
• type ListCustomLogsResponse
• type ListDeletedCustomLogsResponse
• type LogTypesAPI
• type LogTypesAPIPayload
• type PutCustomLogInput
• type PutCustomLogResponse

Types

type DelCustomLogInput

type DelCustomLogInput struct {
	LogType  string `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
	Revision int64  `json:"revision" validate:"min=1" description:"Log record revision"`
}

type DelCustomLogResponse

type DelCustomLogResponse struct {
	Error struct {
		Code    string `json:"code" validate:"required"`
		Message string `json:"message" validate:"required"`
	} `json:"error,omitempty" description:"The delete record"`
}

type GetCustomLogInput

type GetCustomLogInput struct {
	LogType  string `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
	Revision int64  `json:"revision,omitempty" validate:"omitempty,min=1" description:"Log record revision (0 means latest)"`
}

type GetCustomLogResponse

type GetCustomLogResponse struct {
	Result struct {
		LogType      string    `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
		Revision     int64     `json:"revision" validate:"required,min=1" description:"Log record revision"`
		UpdatedAt    time.Time `json:"updatedAt" description:"Last update timestamp of the record"`
		Description  string    `json:"description" description:"Log type description"`
		ReferenceURL string    `json:"referenceURL" description:"A URL with reference docs for the log type"`
		LogSpec      string    `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
	} `json:"record,omitempty" description:"The custom log record (field omitted if an error occurred)"`
	Error struct {
		Code    string `json:"code" validate:"required"`
		Message string `json:"message" validate:"required"`
	} `json:"error,omitempty" description:"An error that occurred while fetching the record"`
}

type ListAvailableLogTypesResponse

type ListAvailableLogTypesResponse struct {
	LogTypes []string `json:"logTypes"`
}

type ListCustomLogsResponse

type ListCustomLogsResponse struct {
	CustomLogs []struct {
		LogType      string    `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
		Revision     int64     `json:"revision" validate:"required,min=1" description:"Log record revision"`
		UpdatedAt    time.Time `json:"updatedAt" description:"Last update timestamp of the record"`
		Description  string    `json:"description" description:"Log type description"`
		ReferenceURL string    `json:"referenceURL" description:"A URL with reference docs for the log type"`
		LogSpec      string    `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
	} `json:"customLogs" description:"Custom log records stored"`
	Error struct {
		Code    string `json:"code" validate:"required"`
		Message string `json:"message" validate:"required"`
	} `json:"error,omitempty" description:"An error that occurred during the operation"`
}

type ListDeletedCustomLogsResponse

type ListDeletedCustomLogsResponse struct {
	LogTypes []string `json:"logTypes,omitempty" description:"A list of ids of deleted log types (omitted if an error occurred)"`
	Error    struct {
		Code    string `json:"code" validate:"required"`
		Message string `json:"message" validate:"required"`
	} `json:"error,omitempty" description:"An error that occurred while fetching the list"`
}

type LogTypesAPI

type LogTypesAPI interface {
	ListAvailableLogTypes() (ListAvailableLogTypesResponse, error)

	ListDeletedCustomLogs() (ListDeletedCustomLogsResponse, error)

	GetCustomLog(input GetCustomLogInput) (GetCustomLogResponse, error)

	PutCustomLog(input PutCustomLogInput) (PutCustomLogResponse, error)

	DelCustomLog(input DelCustomLogInput) (DelCustomLogResponse, error)

	ListCustomLogs() (ListCustomLogsResponse, error)
}

LogTypesAPI available endpoints

type LogTypesAPIPayload

type LogTypesAPIPayload struct {
	ListAvailableLogTypes *struct{}
	ListDeletedCustomLogs *struct{}
	GetCustomLog          *GetCustomLogInput
	PutCustomLog          *PutCustomLogInput
	DelCustomLog          *DelCustomLogInput
	ListCustomLogs        *struct{}
}

LogTypesAPIPayload is the payload for calls to LogTypesAPI endpoints.

type PutCustomLogInput

type PutCustomLogInput struct {
	LogType      string `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
	Revision     int64  `` /* 145-byte string literal not displayed */
	Description  string `json:"description" description:"Log type description"`
	ReferenceURL string `json:"referenceURL" description:"A URL with reference docs for the log type"`
	LogSpec      string `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
}

type PutCustomLogResponse

type PutCustomLogResponse struct {
	Result struct {
		LogType      string    `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
		Revision     int64     `json:"revision" validate:"required,min=1" description:"Log record revision"`
		UpdatedAt    time.Time `json:"updatedAt" description:"Last update timestamp of the record"`
		Description  string    `json:"description" description:"Log type description"`
		ReferenceURL string    `json:"referenceURL" description:"A URL with reference docs for the log type"`
		LogSpec      string    `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
	} `json:"record,omitempty" description:"The modified record (field is omitted if an error occurred)"`
	Error struct {
		Code    string `json:"code" validate:"required"`
		Message string `json:"message" validate:"required"`
	} `json:"error,omitempty" description:"An error that occurred during the operation"`
}