client

package
v1.1.25 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 27, 2024 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildGetSourceMTTRPayload 

func BuildGetSourceMTTRPayload(sourcesGetSourceMTTRID string) (*sources.GetSourceMTTRPayload, error)

BuildGetSourceMTTRPayload builds the payload for the sources Get source MTTR endpoint from CLI flags.

func BuildGetSourcePayload 

func BuildGetSourcePayload(sourcesGetSourceID string) (*sources.GetSourcePayload, error)

BuildGetSourcePayload builds the payload for the sources Get source endpoint from CLI flags.

func BuildListFindingsBySourcePayload 

func BuildListFindingsBySourcePayload(sourcesListFindingsBySourceID string, sourcesListFindingsBySourceStatus string, sourcesListFindingsBySourceSortBy string, sourcesListFindingsBySourcePage string, sourcesListFindingsBySourceSize string) (*sources.ListFindingsBySourcePayload, error)

BuildListFindingsBySourcePayload builds the payload for the sources List findings by source endpoint from CLI flags.

func BuildListSourcesPayload 

func BuildListSourcesPayload(sourcesListSourcesPage string, sourcesListSourcesSize string) (*sources.ListSourcesPayload, error)

BuildListSourcesPayload builds the payload for the sources List sources endpoint from CLI flags.

func DecodeGetSourceMTTRResponse 

func DecodeGetSourceMTTRResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetSourceMTTRResponse returns a decoder for responses returned by the sources Get source MTTR endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeGetSourceResponse 

func DecodeGetSourceResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetSourceResponse returns a decoder for responses returned by the sources Get source endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeListFindingsBySourceResponse 

func DecodeListFindingsBySourceResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListFindingsBySourceResponse returns a decoder for responses returned by the sources List findings by source endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeListSourcesResponse 

func DecodeListSourcesResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListSourcesResponse returns a decoder for responses returned by the sources List sources endpoint. restoreBody controls whether the response body should be restored after having been read.

func EncodeListFindingsBySourceRequest 

func EncodeListFindingsBySourceRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListFindingsBySourceRequest returns an encoder for requests sent to the sources List findings by source server.

func EncodeListSourcesRequest 

func EncodeListSourcesRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListSourcesRequest returns an encoder for requests sent to the sources List sources server.

func GetSourceMTTRSourcesPath 

func GetSourceMTTRSourcesPath(id string) string

GetSourceMTTRSourcesPath returns the URL path to the sources service Get source MTTR HTTP endpoint.

func GetSourceSourcesPath 

func GetSourceSourcesPath(id string) string

GetSourceSourcesPath returns the URL path to the sources service Get source HTTP endpoint.

func ListFindingsBySourceSourcesPath 

func ListFindingsBySourceSourcesPath(id string) string

ListFindingsBySourceSourcesPath returns the URL path to the sources service List findings by source HTTP endpoint.

func ListSourcesSourcesPath 

func ListSourcesSourcesPath() string

ListSourcesSourcesPath returns the URL path to the sources service List sources HTTP endpoint.

func NewGetSourceSourceOK 

func NewGetSourceSourceOK(body *GetSourceResponseBody) *sourcesviews.SourceView

NewGetSourceSourceOK builds a "sources" service "Get source" endpoint result from a HTTP "OK" response.

func NewListFindingsBySourceFindingCollectionOK 

func NewListFindingsBySourceFindingCollectionOK(body ListFindingsBySourceResponseBody) sourcesviews.FindingCollectionView

NewListFindingsBySourceFindingCollectionOK builds a "sources" service "List findings by source" endpoint result from a HTTP "OK" response.

func NewListSourcesSourceCollectionOK 

func NewListSourcesSourceCollectionOK(body ListSourcesResponseBody) sourcesviews.SourceCollectionView

NewListSourcesSourceCollectionOK builds a "sources" service "List sources" endpoint result from a HTTP "OK" response.

Types

type Client 

type Client struct {
	// ListSources Doer is the HTTP client used to make requests to the List
	// sources endpoint.
	ListSourcesDoer goahttp.Doer

	// GetSource Doer is the HTTP client used to make requests to the Get source
	// endpoint.
	GetSourceDoer goahttp.Doer

	// ListFindingsBySource Doer is the HTTP client used to make requests to the
	// List findings by source endpoint.
	ListFindingsBySourceDoer goahttp.Doer

	// GetSourceMTTR Doer is the HTTP client used to make requests to the Get
	// source MTTR endpoint.
	GetSourceMTTRDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the sources service endpoint HTTP clients.

func NewClient 

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the sources service servers.

func (*Client) BuildGetSourceMTTRRequest 

func (c *Client) BuildGetSourceMTTRRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetSourceMTTRRequest instantiates a HTTP request object with method and path set to call the "sources" service "Get source MTTR" endpoint

func (*Client) BuildGetSourceRequest 

func (c *Client) BuildGetSourceRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetSourceRequest instantiates a HTTP request object with method and path set to call the "sources" service "Get source" endpoint

func (*Client) BuildListFindingsBySourceRequest 

func (c *Client) BuildListFindingsBySourceRequest(ctx context.Context, v any) (*http.Request, error)

BuildListFindingsBySourceRequest instantiates a HTTP request object with method and path set to call the "sources" service "List findings by source" endpoint

func (*Client) BuildListSourcesRequest 

func (c *Client) BuildListSourcesRequest(ctx context.Context, v any) (*http.Request, error)

BuildListSourcesRequest instantiates a HTTP request object with method and path set to call the "sources" service "List sources" endpoint

func (*Client) GetSource 

func (c *Client) GetSource() goa.Endpoint

GetSource returns an endpoint that makes HTTP requests to the sources service Get source server.

func (*Client) GetSourceMTTR 

func (c *Client) GetSourceMTTR() goa.Endpoint

GetSourceMTTR returns an endpoint that makes HTTP requests to the sources service Get source MTTR server.

func (*Client) ListFindingsBySource 

func (c *Client) ListFindingsBySource() goa.Endpoint

ListFindingsBySource returns an endpoint that makes HTTP requests to the sources service List findings by source server.

func (*Client) ListSources 

func (c *Client) ListSources() goa.Endpoint

ListSources returns an endpoint that makes HTTP requests to the sources service List sources server.

type FindingResponse 

type FindingResponse struct {
	// Finding ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Issue
	Issue *IssueResponse `form:"issue,omitempty" json:"issue,omitempty" xml:"issue,omitempty"`
	// Target
	Target *TargetResponse `form:"target,omitempty" json:"target,omitempty" xml:"target,omitempty"`
	// Source
	Source *SourcewithnotargetResponse `form:"source,omitempty" json:"source,omitempty" xml:"source,omitempty"`
	// Finding details
	Details *string `form:"details,omitempty" json:"details,omitempty" xml:"details,omitempty"`
	// Finding impact details
	ImpactDetails *string `form:"impact_details,omitempty" json:"impact_details,omitempty" xml:"impact_details,omitempty"`
	// Finding status. Can be 'OPEN' or 'FIXED'.
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Finding severity score
	Score *float32 `form:"score,omitempty" json:"score,omitempty" xml:"score,omitempty"`
	// Other resources associated with the finding
	Resources []*ResourceGroupResponse `form:"resources,omitempty" json:"resources,omitempty" xml:"resources,omitempty"`
}

FindingResponse is used to define fields on response body types.

type GetSourceResponseBody 

type GetSourceResponseBody struct {
	// Source ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Target ID
	TargetID *string `form:"target_id,omitempty" json:"target_id,omitempty" xml:"target_id,omitempty"`
	// Source name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Source component
	Component *string `form:"component,omitempty" json:"component,omitempty" xml:"component,omitempty"`
	// Source instance
	Instance *string `form:"instance,omitempty" json:"instance,omitempty" xml:"instance,omitempty"`
	// Source options
	Options *string `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	// Time on which the source scanned the target
	Time *string `form:"time,omitempty" json:"time,omitempty" xml:"time,omitempty"`
}

GetSourceResponseBody is the type of the "sources" service "Get source" endpoint HTTP response body.

type IssueResponse 

type IssueResponse struct {
	// Issue ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Issue summary
	Summary *string `form:"summary,omitempty" json:"summary,omitempty" xml:"summary,omitempty"`
	// Common Weakness Enumeration ID
	CweID *int `form:"cwe_id,omitempty" json:"cwe_id,omitempty" xml:"cwe_id,omitempty"`
	// Issue description
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Recommendations to fix the issue
	Recommendations []string `form:"recommendations,omitempty" json:"recommendations,omitempty" xml:"recommendations,omitempty"`
	// Documentation reference for the issue
	ReferenceLinks []string `form:"reference_links,omitempty" json:"reference_links,omitempty" xml:"reference_links,omitempty"`
	// Labels associated with the issue
	Labels []string `form:"labels,omitempty" json:"labels,omitempty" xml:"labels,omitempty"`
}

IssueResponse is used to define fields on response body types.

type ListFindingsBySourceResponseBody 

type ListFindingsBySourceResponseBody []*FindingResponse

ListFindingsBySourceResponseBody is the type of the "sources" service "List findings by source" endpoint HTTP response body.

type ListSourcesResponseBody 

type ListSourcesResponseBody []*SourceResponse

ListSourcesResponseBody is the type of the "sources" service "List sources" endpoint HTTP response body.

type ResourceGroupResponse 

type ResourceGroupResponse struct {
	// Name of the resource group
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Column names of the resource group in the order that should be rendered
	Attributes []string `form:"attributes,omitempty" json:"attributes,omitempty" xml:"attributes,omitempty"`
	// List containing the resource rows as hashmap
	Resources []map[string]string `form:"resources,omitempty" json:"resources,omitempty" xml:"resources,omitempty"`
}

ResourceGroupResponse is used to define fields on response body types.

type SourceResponse 

type SourceResponse struct {
	// Source ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Target ID
	TargetID *string `form:"target_id,omitempty" json:"target_id,omitempty" xml:"target_id,omitempty"`
	// Source name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Source component
	Component *string `form:"component,omitempty" json:"component,omitempty" xml:"component,omitempty"`
	// Source instance
	Instance *string `form:"instance,omitempty" json:"instance,omitempty" xml:"instance,omitempty"`
	// Source options
	Options *string `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	// Time on which the source scanned the target
	Time *string `form:"time,omitempty" json:"time,omitempty" xml:"time,omitempty"`
}

SourceResponse is used to define fields on response body types.

type SourcewithnotargetResponse 

type SourcewithnotargetResponse struct {
	// Source ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Source name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Source component
	Component *string `form:"component,omitempty" json:"component,omitempty" xml:"component,omitempty"`
	// Source instance
	Instance *string `form:"instance,omitempty" json:"instance,omitempty" xml:"instance,omitempty"`
	// Source options
	Options *string `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	// Time on which the source scanned the target
	Time *string `form:"time,omitempty" json:"time,omitempty" xml:"time,omitempty"`
}

SourcewithnotargetResponse is used to define fields on response body types.

type TargetResponse 

type TargetResponse struct {
	// Target ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Target identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" xml:"identifier,omitempty"`
	// List of teams associated with target
	Teams []string `form:"teams,omitempty" json:"teams,omitempty" xml:"teams,omitempty"`
}

TargetResponse is used to define fields on response body types.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.