Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add json tags to processor specification #23

Merged
merged 2 commits into from
Feb 29, 2024
Merged

Add json tags to processor specification #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bde98b6
add json tags to processor specification
lovromazgon Feb 29, 2024
1f3d39c
go mod tidy
lovromazgon Feb 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ toolchain go1.21.5

require (
github.com/bufbuild/buf v1.29.0
github.com/conduitio/conduit-commons v0.0.0-20240216175021-58737e44eb62
github.com/conduitio/conduit-commons v0.0.0-20240229142452-df003dec114a
github.com/golangci/golangci-lint v1.56.2
github.com/matryer/is v1.4.1
github.com/rs/zerolog v1.32.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5P
github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
github.com/conduitio/conduit-commons v0.0.0-20240216175021-58737e44eb62 h1:h1AcneviaadJqw1KAUfzIDBVrODma4rneg13q726KQU=
github.com/conduitio/conduit-commons v0.0.0-20240216175021-58737e44eb62/go.mod h1:Hhr5nik71/Wz3yrLjaKSZ2HRQp1wNSOPY2JGGKz7fsw=
github.com/conduitio/conduit-commons v0.0.0-20240229142452-df003dec114a h1:sYqOLuHKthGfpQHNmiXP4c6cYl9JRFfcDGB8Mahm1E0=
github.com/conduitio/conduit-commons v0.0.0-20240229142452-df003dec114a/go.mod h1:Hhr5nik71/Wz3yrLjaKSZ2HRQp1wNSOPY2JGGKz7fsw=
github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I=
github.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo=
github.com/containerd/stargz-snapshotter/estargz v0.15.1 h1:eXJjw9RbkLFgioVaTG+G/ZW/0kEe2oEKCdS/ZxIyoCU=
Expand Down
12 changes: 6 additions & 6 deletions processor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,19 +62,19 @@ type Processor interface {
// and allows them to describe their parameters.
type Specification struct {
// Name is the name of the processor.
Name string
Name string `json:"name"`
// Summary is a brief description of the processor and what it does.
Summary string
Summary string `json:"summary"`
// Description is a more long form area appropriate for README-like text
// that the author can provide for documentation about the specified
// Parameters.
Description string
Description string `json:"description"`
// Version string. Should be a semver prepended with `v`, e.g. `v1.54.3`.
Version string
Version string `json:"version"`
// Author declares the entity that created or maintains this processor.
Author string
Author string `json:"author"`
// Parameters describe how to configure the processor.
Parameters config.Parameters
Parameters config.Parameters `json:"parameters"`
}

// ProcessedRecord is a record returned by the processor.
Expand Down
Loading