mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
09c4dbdb9f
* Correlations: add UpdateCorrelation HTTP API * handle correlation not found * add tests * fix lint errors * add bad request to API spec * change casing * fix casing in docs * fix tests * update spec
104 lines
3.2 KiB
Go
104 lines
3.2 KiB
Go
package correlations
|
|
|
|
import (
|
|
"errors"
|
|
)
|
|
|
|
var (
|
|
ErrSourceDataSourceReadOnly = errors.New("source data source is read only")
|
|
ErrSourceDataSourceDoesNotExists = errors.New("source data source does not exist")
|
|
ErrTargetDataSourceDoesNotExists = errors.New("target data source does not exist")
|
|
ErrCorrelationFailedGenerateUniqueUid = errors.New("failed to generate unique correlation UID")
|
|
ErrCorrelationNotFound = errors.New("correlation not found")
|
|
ErrUpdateCorrelationEmptyParams = errors.New("not enough parameters to edit correlation")
|
|
)
|
|
|
|
// Correlation is the model for correlations definitions
|
|
type Correlation struct {
|
|
// Unique identifier of the correlation
|
|
// example: 50xhMlg9k
|
|
UID string `json:"uid" xorm:"pk 'uid'"`
|
|
// UID of the data source the correlation originates from
|
|
// example:d0oxYRg4z
|
|
SourceUID string `json:"sourceUID" xorm:"pk 'source_uid'"`
|
|
// UID of the data source the correlation points to
|
|
// example:PE1C5CBDA0504A6A3
|
|
TargetUID string `json:"targetUID" xorm:"target_uid"`
|
|
// Label identifying the correlation
|
|
// example: My Label
|
|
Label string `json:"label" xorm:"label"`
|
|
// Description of the correlation
|
|
// example: Logs to Traces
|
|
Description string `json:"description" xorm:"description"`
|
|
}
|
|
|
|
// CreateCorrelationResponse is the response struct for CreateCorrelationCommand
|
|
// swagger:model
|
|
type CreateCorrelationResponseBody struct {
|
|
Result Correlation `json:"result"`
|
|
// example: Correlation created
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
// CreateCorrelationCommand is the command for creating a correlation
|
|
// swagger:model
|
|
type CreateCorrelationCommand struct {
|
|
// UID of the data source for which correlation is created.
|
|
SourceUID string `json:"-"`
|
|
OrgId int64 `json:"-"`
|
|
SkipReadOnlyCheck bool `json:"-"`
|
|
// Target data source UID to which the correlation is created
|
|
// example:PE1C5CBDA0504A6A3
|
|
TargetUID string `json:"targetUID" binding:"Required"`
|
|
// Optional label identifying the correlation
|
|
// example: My label
|
|
Label string `json:"label"`
|
|
// Optional description of the correlation
|
|
// example: Logs to Traces
|
|
Description string `json:"description"`
|
|
}
|
|
|
|
// swagger:model
|
|
type DeleteCorrelationResponseBody struct {
|
|
// example: Correlation deleted
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
// DeleteCorrelationCommand is the command for deleting a correlation
|
|
type DeleteCorrelationCommand struct {
|
|
// UID of the correlation to be deleted.
|
|
UID string
|
|
SourceUID string
|
|
OrgId int64
|
|
}
|
|
|
|
// swagger:model
|
|
type UpdateCorrelationResponseBody struct {
|
|
Result Correlation `json:"result"`
|
|
// example: Correlation updated
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
// UpdateCorrelationCommand is the command for updating a correlation
|
|
type UpdateCorrelationCommand struct {
|
|
// UID of the correlation to be deleted.
|
|
UID string `json:"-"`
|
|
SourceUID string `json:"-"`
|
|
OrgId int64 `json:"-"`
|
|
|
|
// Optional label identifying the correlation
|
|
// example: My label
|
|
Label *string `json:"label"`
|
|
// Optional description of the correlation
|
|
// example: Logs to Traces
|
|
Description *string `json:"description"`
|
|
}
|
|
|
|
type DeleteCorrelationsBySourceUIDCommand struct {
|
|
SourceUID string
|
|
}
|
|
|
|
type DeleteCorrelationsByTargetUIDCommand struct {
|
|
TargetUID string
|
|
}
|