local_models

package
v0.0.0-...-bae184c Latest Latest
Warning

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

 Go to latest Published: Sep 25, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package local_models provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BusinessCriticalityRiskFactor 

type BusinessCriticalityRiskFactor struct {
	Factor BusinessCriticalityRiskFactorFactor `json:"factor"`
	Value  BusinessCriticalityRiskFactorValue  `json:"value"`
}

BusinessCriticalityRiskFactor defines model for BusinessCriticalityRiskFactor.

type BusinessCriticalityRiskFactorFactor 

type BusinessCriticalityRiskFactorFactor string

BusinessCriticalityRiskFactorFactor defines model for BusinessCriticalityRiskFactor.Factor. 

const (
	BusinessCriticality BusinessCriticalityRiskFactorFactor = "business-criticality"
)

Defines values for BusinessCriticalityRiskFactorFactor.

type BusinessCriticalityRiskFactorValue 

type BusinessCriticalityRiskFactorValue string

BusinessCriticalityRiskFactorValue defines model for BusinessCriticalityRiskFactor.Value. 

const (
	BusinessCriticalityRiskFactorValueHigh   BusinessCriticalityRiskFactorValue = "high"
	BusinessCriticalityRiskFactorValueLow    BusinessCriticalityRiskFactorValue = "low"
	BusinessCriticalityRiskFactorValueMedium BusinessCriticalityRiskFactorValue = "medium"
)

Defines values for BusinessCriticalityRiskFactorValue.

type CodeSastFingerprintV0 

type CodeSastFingerprintV0 struct {
	Scheme CodeSastFingerprintV0Scheme `json:"scheme"`
	Value  string                      `json:"value"`
}

CodeSastFingerprintV0 defines model for CodeSastFingerprintV0.

type CodeSastFingerprintV0Scheme 

type CodeSastFingerprintV0Scheme string

CodeSastFingerprintV0Scheme defines model for CodeSastFingerprintV0.Scheme. 

const (
	CodeSastV0 CodeSastFingerprintV0Scheme = "code-sast-v0"
)

Defines values for CodeSastFingerprintV0Scheme.

type CodeSastFingerprintV1 

type CodeSastFingerprintV1 struct {
	Scheme CodeSastFingerprintV1Scheme `json:"scheme"`
	Value  string                      `json:"value"`
}

CodeSastFingerprintV1 defines model for CodeSastFingerprintV1.

type CodeSastFingerprintV1Scheme 

type CodeSastFingerprintV1Scheme string

CodeSastFingerprintV1Scheme defines model for CodeSastFingerprintV1.Scheme. 

const (
	CodeSastV1 CodeSastFingerprintV1Scheme = "code-sast-v1"
)

Defines values for CodeSastFingerprintV1Scheme.

type Component 

type Component struct {
	// Name Name of the component. Names are free-form and semantically meaningful in the context of
	// what is being scanned, and how it is being scanned. It may or may not be a file name or path,
	// depending on what is scanned.
	Name string `json:"name"`

	// ScanType Scan type of the component.
	ScanType ScanType `json:"scan_type"`
}

Component A Component (as in, software component) is the subject of a security scan.

type ContentAddress 

type ContentAddress struct {
	// contains filtered or unexported fields
}

ContentAddress Content address whence source code can be obtained for scanning.

func (ContentAddress) AsLegacyDeepcodeBundleAddress 

func (t ContentAddress) AsLegacyDeepcodeBundleAddress() (LegacyDeepcodeBundleAddress, error)

AsLegacyDeepcodeBundleAddress returns the union data inside the ContentAddress as a LegacyDeepcodeBundleAddress

func (ContentAddress) AsWorkspaceV1Address 

func (t ContentAddress) AsWorkspaceV1Address() (WorkspaceV1Address, error)

AsWorkspaceV1Address returns the union data inside the ContentAddress as a WorkspaceV1Address

func (ContentAddress) Discriminator 

func (t ContentAddress) Discriminator() (string, error)

func (*ContentAddress) FromLegacyDeepcodeBundleAddress 

func (t *ContentAddress) FromLegacyDeepcodeBundleAddress(v LegacyDeepcodeBundleAddress) error

FromLegacyDeepcodeBundleAddress overwrites any union data inside the ContentAddress as the provided LegacyDeepcodeBundleAddress

func (*ContentAddress) FromWorkspaceV1Address 

func (t *ContentAddress) FromWorkspaceV1Address(v WorkspaceV1Address) error

FromWorkspaceV1Address overwrites any union data inside the ContentAddress as the provided WorkspaceV1Address

func (ContentAddress) MarshalJSON 

func (t ContentAddress) MarshalJSON() ([]byte, error)

func (*ContentAddress) MergeLegacyDeepcodeBundleAddress 

func (t *ContentAddress) MergeLegacyDeepcodeBundleAddress(v LegacyDeepcodeBundleAddress) error

MergeLegacyDeepcodeBundleAddress performs a merge with any union data inside the ContentAddress, using the provided LegacyDeepcodeBundleAddress

func (*ContentAddress) MergeWorkspaceV1Address 

func (t *ContentAddress) MergeWorkspaceV1Address(v WorkspaceV1Address) error

MergeWorkspaceV1Address performs a merge with any union data inside the ContentAddress, using the provided WorkspaceV1Address

func (*ContentAddress) UnmarshalJSON 

func (t *ContentAddress) UnmarshalJSON(b []byte) error

func (ContentAddress) ValueByDiscriminator 

func (t ContentAddress) ValueByDiscriminator() (interface{}, error)

type ContentAddressInput 

type ContentAddressInput struct {
	// Spec Content address specification, which defines the target address to test, or a
	// pair of addresses to test for a differential test.
	Spec ContentAddressSpec      `json:"spec"`
	Type ContentAddressInputType `json:"type"`
}

ContentAddressInput Test input obtained from a source code image, addressed by its content digest.

type ContentAddressInputType 

type ContentAddressInputType string

ContentAddressInputType defines model for ContentAddressInput.Type. 

const (
	ContentAddressInputTypeContentAddress ContentAddressInputType = "content-address"
)

Defines values for ContentAddressInputType.

type ContentAddressSpec 

type ContentAddressSpec struct {
	// Base Base content for a differential test. When provided,
	// FindingAttributes.delta will be set with respect to the base in results.
	//
	// Otherwise FindingAttributes.delta is left unset.
	Base *ContentAddress `json:"base,omitempty"`

	// Target Target content to be scanned for this security test.
	Target ContentAddress `json:"target"`
}

ContentAddressSpec Content address specification, which defines the target address to test, or a pair of addresses to test for a differential test.

type CreateExcludeRule 

type CreateExcludeRule struct {
	// contains filtered or unexported fields
}

CreateExcludeRule CreateExcludeRule defines individual rules for exclusion of files during a test. Currently it supports either bare strings as recursive globs, or explicitly stated file patterns as recursive globs.

func (CreateExcludeRule) AsCreateExcludeRule0 

func (t CreateExcludeRule) AsCreateExcludeRule0() (CreateExcludeRule0, error)

AsCreateExcludeRule0 returns the union data inside the CreateExcludeRule as a CreateExcludeRule0

func (CreateExcludeRule) AsCreateObjectExcludeRule 

func (t CreateExcludeRule) AsCreateObjectExcludeRule() (CreateObjectExcludeRule, error)

AsCreateObjectExcludeRule returns the union data inside the CreateExcludeRule as a CreateObjectExcludeRule

func (*CreateExcludeRule) FromCreateExcludeRule0 

func (t *CreateExcludeRule) FromCreateExcludeRule0(v CreateExcludeRule0) error

FromCreateExcludeRule0 overwrites any union data inside the CreateExcludeRule as the provided CreateExcludeRule0

func (*CreateExcludeRule) FromCreateObjectExcludeRule 

func (t *CreateExcludeRule) FromCreateObjectExcludeRule(v CreateObjectExcludeRule) error

FromCreateObjectExcludeRule overwrites any union data inside the CreateExcludeRule as the provided CreateObjectExcludeRule

func (CreateExcludeRule) MarshalJSON 

func (t CreateExcludeRule) MarshalJSON() ([]byte, error)

func (*CreateExcludeRule) MergeCreateExcludeRule0 

func (t *CreateExcludeRule) MergeCreateExcludeRule0(v CreateExcludeRule0) error

MergeCreateExcludeRule0 performs a merge with any union data inside the CreateExcludeRule, using the provided CreateExcludeRule0

func (*CreateExcludeRule) MergeCreateObjectExcludeRule 

func (t *CreateExcludeRule) MergeCreateObjectExcludeRule(v CreateObjectExcludeRule) error

MergeCreateObjectExcludeRule performs a merge with any union data inside the CreateExcludeRule, using the provided CreateObjectExcludeRule

func (*CreateExcludeRule) UnmarshalJSON 

func (t *CreateExcludeRule) UnmarshalJSON(b []byte) error

type CreateExcludeRule0 

type CreateExcludeRule0 = string

CreateExcludeRule0 defines model for .

type CreateObjectExcludeRule 

type CreateObjectExcludeRule = FileObjectExcludeRule

CreateObjectExcludeRule defines model for CreateObjectExcludeRule.

type CreateTestAttributes 

type CreateTestAttributes struct {
	// Context Test context; pertinent information important to associate with the outcome
	// of the test and its further processing, but is not directly used in the
	// test.
	//
	// These are worth modeling with a concrete type, rather than as generic
	// free-form metadata to communicate to consumers of the test what values are
	// available.
	Context *CreateTestContext `json:"context,omitempty"`

	// Input Test inputs; what will be tested.
	Input TestInput `json:"input"`

	// Options CreateTestOptions are arguments which configure the test and determine the
	// behavior of how it is conducted.
	//
	// Options are optional when creating a test and may be derived from other
	// sources, such as a test configuration policy if not specified. Provided
	// options may be merged with or overridden by such policy.
	//
	// In the requested Test resource, these options will reflect the effective
	// options resolved and applied to the execution of the test.
	Options *CreateTestOptions `json:"options,omitempty"`
}

CreateTestAttributes Attributes provided when creating a new test.

type CreateTestContext 

type CreateTestContext struct {
	// GitScmBranch Git SCM branch associated with the content, if known.
	//
	// This allows providing the Git SCM branch as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on a feature branch.
	GitScmBranch *string `json:"git_scm_branch,omitempty"`

	// GitScmUrl Git SCM URL associated with the content, if known.
	//
	// This allows providing the Git SCM URL as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on source code which was cloned
	// from, and will be proposed for merging back into, an SCM repository.
	GitScmUrl *string `json:"git_scm_url,omitempty"`

	// SdlcStage Indicate at which point in the SDLC lifecycle the test was executed.
	SdlcStage CreateTestContextSdlcStage `json:"sdlc_stage"`
}

CreateTestContext CreateTestContext identifies the context in which this Test occurs.

type CreateTestContextSdlcStage 

type CreateTestContextSdlcStage string

CreateTestContextSdlcStage Indicate at which point in the SDLC lifecycle the test was executed. 

const (
	CreateTestContextSdlcStageCicd      CreateTestContextSdlcStage = "cicd"
	CreateTestContextSdlcStageDev       CreateTestContextSdlcStage = "dev"
	CreateTestContextSdlcStagePrcheck   CreateTestContextSdlcStage = "prcheck"
	CreateTestContextSdlcStageRecurring CreateTestContextSdlcStage = "recurring"
)

Defines values for CreateTestContextSdlcStage.

type CreateTestJSONRequestBody 

type CreateTestJSONRequestBody = CreateTestAttributes

CreateTestJSONRequestBody defines body for CreateTest for application/json ContentType.

type CreateTestOptions 

type CreateTestOptions struct {
	// Exclude Files from which findings should be excluded and removed from
	// results.
	//
	// This is different from FindingAttributes.suppressions; the exclude is an
	// up-front declaration that findings in the excluded files are
	// immaterial to the test result (pass/fail), and should not be reported at all.
	//
	// Excluded files might still be used to link other files/findings though. For
	// example, a SAST (source-to-sink) or SCA analysis (transitive dependency
	// chain) might transit an excluded file, enabling discovery in a
	// non-excluded file.
	Exclude *[]CreateExcludeRule `json:"exclude,omitempty"`
}

CreateTestOptions CreateTestOptions defines options which determine how the Test is conducted.

type CreateTestParams 

type CreateTestParams struct {
	// Version The API version requested.
	Version IoSnykApiRequestSnykApiRequestVersion `form:"version" json:"version"`

	// SnykRequestId A unique ID assigned to each API request, for tracing and troubleshooting.
	//
	// Snyk clients can optionally provide this ID.
	SnykRequestId *IoSnykApiRequestSnykApiRequestRequestId `json:"snyk-request-id,omitempty"`

	// SnykInteractionId Identifies the Snyk client interaction in which this API request occurs.
	//
	// The identifier is an opaque string. though at the time of writing it may either be a
	// uuid or a urn containing a uuid and some metadata.
	// to be safe, the
	SnykInteractionId *IoSnykApiRequestSnykApiRequestInteractionId `json:"snyk-interaction-id,omitempty"`
}

CreateTestParams defines parameters for CreateTest.

type CvssRiskFactor 

type CvssRiskFactor struct {
	// CvssVersion The CVSS version being described. This will be a published CVSS
	// specification version, such as "3.1" or "4.0"
	CvssVersion string               `json:"cvss_version"`
	Factor      CvssRiskFactorFactor `json:"factor"`

	// Vector CVSS vector string, the format of which may be CVSS specification version
	// dependent.
	//
	// See https://www.first.org/cvss/specification-document#Vector-String for
	// details.
	Vector string `json:"vector"`
}

CvssRiskFactor defines model for CvssRiskFactor.

type CvssRiskFactorFactor 

type CvssRiskFactorFactor string

CvssRiskFactorFactor defines model for CvssRiskFactor.Factor. 

const (
	Cvss CvssRiskFactorFactor = "cvss"
)

Defines values for CvssRiskFactorFactor.

type EpssRiskFactor 

type EpssRiskFactor struct {
	Factor EpssRiskFactorFactor `json:"factor"`
	Value  float32              `json:"value"`
}

EpssRiskFactor defines model for EpssRiskFactor.

type EpssRiskFactorFactor 

type EpssRiskFactorFactor string

EpssRiskFactorFactor defines model for EpssRiskFactor.Factor. 

const (
	Epss EpssRiskFactorFactor = "epss"
)

Defines values for EpssRiskFactorFactor.

type ExcludeRule 

type ExcludeRule struct {
	// contains filtered or unexported fields
}

ExcludeRule ExcludeRule defines individual rules for exclusion of files during a test. Currently it supports either bare strings as recursive globs, or explicitly stated file patterns as recursive globs.

func (ExcludeRule) AsExcludeRule0 

func (t ExcludeRule) AsExcludeRule0() (ExcludeRule0, error)

AsExcludeRule0 returns the union data inside the ExcludeRule as a ExcludeRule0

func (ExcludeRule) AsObjectExcludeRule 

func (t ExcludeRule) AsObjectExcludeRule() (ObjectExcludeRule, error)

AsObjectExcludeRule returns the union data inside the ExcludeRule as a ObjectExcludeRule

func (*ExcludeRule) FromExcludeRule0 

func (t *ExcludeRule) FromExcludeRule0(v ExcludeRule0) error

FromExcludeRule0 overwrites any union data inside the ExcludeRule as the provided ExcludeRule0

func (*ExcludeRule) FromObjectExcludeRule 

func (t *ExcludeRule) FromObjectExcludeRule(v ObjectExcludeRule) error

FromObjectExcludeRule overwrites any union data inside the ExcludeRule as the provided ObjectExcludeRule

func (ExcludeRule) MarshalJSON 

func (t ExcludeRule) MarshalJSON() ([]byte, error)

func (*ExcludeRule) MergeExcludeRule0 

func (t *ExcludeRule) MergeExcludeRule0(v ExcludeRule0) error

MergeExcludeRule0 performs a merge with any union data inside the ExcludeRule, using the provided ExcludeRule0

func (*ExcludeRule) MergeObjectExcludeRule 

func (t *ExcludeRule) MergeObjectExcludeRule(v ObjectExcludeRule) error

MergeObjectExcludeRule performs a merge with any union data inside the ExcludeRule, using the provided ObjectExcludeRule

func (*ExcludeRule) UnmarshalJSON 

func (t *ExcludeRule) UnmarshalJSON(b []byte) error

type ExcludeRule0 

type ExcludeRule0 = string

ExcludeRule0 defines model for .

type FileObjectExcludeRule 

type FileObjectExcludeRule struct {
	Type FileObjectExcludeRuleType `json:"type"`

	// Value A recursive glob matching files. Equivalent to a bare string.
	Value string `json:"value"`
}

FileObjectExcludeRule defines model for FileObjectExcludeRule.

type FileObjectExcludeRuleType 

type FileObjectExcludeRuleType string

FileObjectExcludeRuleType defines model for FileObjectExcludeRule.Type. 

const (
	File FileObjectExcludeRuleType = "file"
)

Defines values for FileObjectExcludeRuleType.

type FindingAttributes 

type FindingAttributes struct {
	// Component Component in which the finding was discovered.
	Component Component `json:"component"`

	// Delta Represent whether a finding is net new (introduced), removed, or preserved
	// in a test involving a diff between inputs.
	//
	// Only set in a differential test conducted with respect to base content.
	Delta *FindingAttributesDelta `json:"delta,omitempty"`

	// Fingerprint Natural key, or fingerprint, to identify the same Finding across multiple
	// Test runs. Unique per Test. Here's why:
	// https://github.com/snyk/pr-experience-poc/blob/main/docs/design-documents/pr-inline-comments.md#why-do-we-need-fingerprints
	Fingerprint Fingerprint `json:"fingerprint"`

	// Locations A set of locations where the result was detected. Only one location should
	// be included unless the finding can only be resolved by making a change at
	// every location.
	Locations *[]FindingLocation `json:"locations,omitempty"`
	Message   struct {
		// Arguments Arguments to the finding rule.
		//
		// Mapped from `sarif.Runs.Results.Message.Arguments`.
		Arguments []string `json:"arguments"`

		// Header Short text description of finding rule.
		//
		// Could be sourced from `sarif.Runs.Tool.Driver.Rules.ShortDescription.Text`.
		Header string `json:"header"`

		// Markdown Markdown description of the finding rule.
		//
		// Mapped from `sarif.Runs.Results.Message.Markdown`.
		Markdown string `json:"markdown"`

		// Text Full text description of the finding rule.
		//
		// Mapped from `sarif.Runs.Results.Message.Text`.
		Text string `json:"text"`
	} `json:"message"`

	// Rating The severity and risk rating of the vulnerability
	Rating *FindingRating `json:"rating,omitempty"`

	// Suggestions Suggestions are indications given to the user that might help with
	// mitigating the finding.
	//
	// For mitigation with a higher degree of confidence, remediation and fix
	// relationship links should be used.
	Suggestions *[]Suggestion `json:"suggestions,omitempty"`

	// Suppression Reasons for why a Finding can be suppressed from a Test result. This MAY NOT be required at all, given the presentation
	Suppression *Suppression `json:"suppression,omitempty"`
}

FindingAttributes A Finding entity with a common format for all types of security scans. Notably, this is a sub-resource of a Test.

type FindingAttributesDelta 

type FindingAttributesDelta string

FindingAttributesDelta Represent whether a finding is net new (introduced), removed, or preserved in a test involving a diff between inputs.

Only set in a differential test conducted with respect to base content. 

const (
	Existing   FindingAttributesDelta = "existing"
	Introduced FindingAttributesDelta = "introduced"
	Removed    FindingAttributesDelta = "removed"
)

Defines values for FindingAttributesDelta.

type FindingCounts 

type FindingCounts = IoSnykApiCommonCollectionCounts

FindingCounts CollectionCounts implements the Snyk REST API standard representation for collection counts.

Collection counts may be provided as metadata on a collection resource or in an attribute of a parent resource.

See https://snyk.roadie.so/docs/default/component/sweater-comb/standards/rest/#collection-counts.

type FindingLocation 

type FindingLocation struct {
	DependencyPath *[]ScaPackage `json:"dependency_path,omitempty"`

	// SourceLocations Original locations are necessary for "existing" and "removed" findings. Locations should be available for all scan types where possible.
	SourceLocations *FindingSourceLocation `json:"source_locations,omitempty"`
}

FindingLocation defines model for FindingLocation.

type FindingRating 

type FindingRating struct {
	// Justification Optional reason for rating the vulnerability like this
	Justification *string      `json:"justification,omitempty"`
	Risk          *FindingRisk `json:"risk,omitempty"`

	// Severity A value which may be modified by enrichment stages.
	Severity struct {
		// OriginalValue Original value, if modified.
		OriginalValue *FindingRatingSeverityOriginalValue `json:"original_value,omitempty"`

		// Reason Reason for the modification, if modified.
		Reason *FindingRatingSeverityReason `json:"reason,omitempty"`

		// Value Current value.
		Value FindingRatingSeverityValue `json:"value"`
	} `json:"severity"`
	SeverityMethod FindingRatingSeverityMethod `json:"severity_method"`
}

FindingRating The severity and risk rating of the vulnerability

type FindingRatingSeverityMethod 

type FindingRatingSeverityMethod string

FindingRatingSeverityMethod defines model for FindingRating.SeverityMethod. 

const (
	FindingRatingSeverityMethodCVSSv2  FindingRatingSeverityMethod = "CVSSv2"
	FindingRatingSeverityMethodCVSSv3  FindingRatingSeverityMethod = "CVSSv3"
	FindingRatingSeverityMethodCVSSv31 FindingRatingSeverityMethod = "CVSSv31"
	FindingRatingSeverityMethodCVSSv4  FindingRatingSeverityMethod = "CVSSv4"
	FindingRatingSeverityMethodOWASP   FindingRatingSeverityMethod = "OWASP"
	FindingRatingSeverityMethodOther   FindingRatingSeverityMethod = "other"
)

Defines values for FindingRatingSeverityMethod.

type FindingRatingSeverityOriginalValue 

type FindingRatingSeverityOriginalValue string

FindingRatingSeverityOriginalValue Original value, if modified. 

const (
	FindingRatingSeverityOriginalValueCritical FindingRatingSeverityOriginalValue = "critical"
	FindingRatingSeverityOriginalValueHigh     FindingRatingSeverityOriginalValue = "high"
	FindingRatingSeverityOriginalValueInfo     FindingRatingSeverityOriginalValue = "info"
	FindingRatingSeverityOriginalValueLow      FindingRatingSeverityOriginalValue = "low"
	FindingRatingSeverityOriginalValueMedium   FindingRatingSeverityOriginalValue = "medium"
	FindingRatingSeverityOriginalValueNone     FindingRatingSeverityOriginalValue = "none"
)

Defines values for FindingRatingSeverityOriginalValue.

type FindingRatingSeverityReason 

type FindingRatingSeverityReason string

FindingRatingSeverityReason Reason for the modification, if modified. 

const (
	FindingRatingSeverityReasonManual FindingRatingSeverityReason = "manual"
	FindingRatingSeverityReasonOther  FindingRatingSeverityReason = "other"
	FindingRatingSeverityReasonPolicy FindingRatingSeverityReason = "policy"
)

Defines values for FindingRatingSeverityReason.

type FindingRatingSeverityValue 

type FindingRatingSeverityValue string

FindingRatingSeverityValue Current value. 

const (
	Critical FindingRatingSeverityValue = "critical"
	High     FindingRatingSeverityValue = "high"
	Info     FindingRatingSeverityValue = "info"
	Low      FindingRatingSeverityValue = "low"
	Medium   FindingRatingSeverityValue = "medium"
	None     FindingRatingSeverityValue = "none"
)

Defines values for FindingRatingSeverityValue.

type FindingRelationships 

type FindingRelationships struct {
	// Autofixes Relate to autofixes for the finding, if available.
	Autofixes *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"autofixes,omitempty"`

	// Explanation Relate to a human-readable webpage that explains the finding, if available.
	Explanation *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"explanation,omitempty"`

	// FixDetails Relate to fix information for the finding, if available.
	FixDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"fix_details,omitempty"`

	// PolicyModifications Policy modifications applied to this finding, if available.
	PolicyModifications *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"policy_modifications,omitempty"`

	// RawDetails Relate to the raw scan outputs. May be SARIF, CycloneDX+VEX or other
	// scan-specific formats.
	//
	// The relationship link should point to the resource URL where the raw scan
	// output can be retrieved.
	//
	// The link MAY include a URL fragment to locate the finding's position within
	// the document object.
	//
	// For JSON-based MIME types, this fragment MUST be a JSON Pointer.
	// For XML-based MIME types, this fragment MUST be an XPath expression.
	//
	// If the fragment is specified, the fragment form MUST be compatible with all
	// of the content types advertised. For example, the link MUST NOT provide a JSON
	// Pointer fragment if an XML media type is advertised.
	RawDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink           `json:"links"`
		Meta  FindingRelationships_RawDetails_Meta `json:"meta"`
	} `json:"raw_details,omitempty"`

	// Remediations Relate to remediations for the finding, if available.
	Remediations *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"remediations,omitempty"`

	// SastRuleDetails Relate to details about the rule which was violated in a SAST finding.
	SastRuleDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"sast_rule_details,omitempty"`

	// ScaVulnDetails Relate to details about the component vulnerability discovered in the SCA
	// finding.
	ScaVulnDetails *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"sca_vuln_details,omitempty"`
}

FindingRelationships Resources which may relate to a Finding.

type FindingRelationships_RawDetails_Meta 

type FindingRelationships_RawDetails_Meta struct {
	// ContentTypes Content MIME types which can be used in the Accept header when requesting the
	// related raw data.
	//
	// This property must not be empty, making explicit what type of content
	// the API client will be receiving in the raw details resource response.
	ContentTypes         []string               `json:"content_types"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

FindingRelationships_RawDetails_Meta defines model for FindingRelationships.RawDetails.Meta.

func (FindingRelationships_RawDetails_Meta) Get 

func (a FindingRelationships_RawDetails_Meta) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for FindingRelationships_RawDetails_Meta. Returns the specified element and whether it was found

func (FindingRelationships_RawDetails_Meta) MarshalJSON 

func (a FindingRelationships_RawDetails_Meta) MarshalJSON() ([]byte, error)

Override default JSON handling for FindingRelationships_RawDetails_Meta to handle AdditionalProperties

func (*FindingRelationships_RawDetails_Meta) Set 

func (a *FindingRelationships_RawDetails_Meta) Set(fieldName string, value interface{})

Setter for additional properties for FindingRelationships_RawDetails_Meta

func (*FindingRelationships_RawDetails_Meta) UnmarshalJSON 

func (a *FindingRelationships_RawDetails_Meta) UnmarshalJSON(b []byte) error

Override default JSON handling for FindingRelationships_RawDetails_Meta to handle AdditionalProperties

type FindingResource 

type FindingResource struct {
	// Attributes A Finding entity with a common format for all types of security scans. Notably, this is a sub-resource of a Test.
	Attributes FindingAttributes `json:"attributes"`

	// Id Unique identity of this Finding instance.
	Id openapi_types.UUID `json:"id"`

	// Relationships Resources which may relate to a Finding.
	Relationships FindingRelationships `json:"relationships"`
	Type          FindingResourceType  `json:"type"`
}

FindingResource FindingResource models a JSON API Finding resource.

type FindingResourceType 

type FindingResourceType string

FindingResourceType defines model for FindingResource.Type. 

const (
	Findings FindingResourceType = "findings"
)

Defines values for FindingResourceType.

type FindingRisk 

type FindingRisk struct {
	Factors RiskFactors `json:"factors"`
	Score   int         `json:"score"`
}

FindingRisk defines model for FindingRisk.

type FindingSourceLocation 

type FindingSourceLocation struct {
	// Filepath Maps `sarif.Runs.Results.Location.PhysicalLocation.ArtifactLocation.URI`
	Filepath string `json:"filepath"`

	// OriginalEndColumn Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.EndColumn`
	OriginalEndColumn int `json:"original_end_column"`

	// OriginalEndLine Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.EndLine`
	OriginalEndLine int `json:"original_end_line"`

	// OriginalStartColumn Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.StartColumn`
	OriginalStartColumn int `json:"original_start_column"`

	// OriginalStartLine Maps `sarif.Runs.Results.Location.PhysicalLocation.Region.StartLine`
	OriginalStartLine int `json:"original_start_line"`
}

FindingSourceLocation Original locations are necessary for "existing" and "removed" findings. Locations should be available for all scan types where possible.

type FindingsSummary 

type FindingsSummary struct {
	Counts FindingCounts `json:"counts"`
}

FindingsSummary Summary statistics about a Test's Findings.

type Fingerprint 

type Fingerprint struct {
	// contains filtered or unexported fields
}

Fingerprint defines model for Fingerprint.

func (Fingerprint) AsCodeSastFingerprintV0 

func (t Fingerprint) AsCodeSastFingerprintV0() (CodeSastFingerprintV0, error)

AsCodeSastFingerprintV0 returns the union data inside the Fingerprint as a CodeSastFingerprintV0

func (Fingerprint) AsCodeSastFingerprintV1 

func (t Fingerprint) AsCodeSastFingerprintV1() (CodeSastFingerprintV1, error)

AsCodeSastFingerprintV1 returns the union data inside the Fingerprint as a CodeSastFingerprintV1

func (Fingerprint) AsScaProblemFingerprint 

func (t Fingerprint) AsScaProblemFingerprint() (ScaProblemFingerprint, error)

AsScaProblemFingerprint returns the union data inside the Fingerprint as a ScaProblemFingerprint

func (Fingerprint) Discriminator 

func (t Fingerprint) Discriminator() (string, error)

func (*Fingerprint) FromCodeSastFingerprintV0 

func (t *Fingerprint) FromCodeSastFingerprintV0(v CodeSastFingerprintV0) error

FromCodeSastFingerprintV0 overwrites any union data inside the Fingerprint as the provided CodeSastFingerprintV0

func (*Fingerprint) FromCodeSastFingerprintV1 

func (t *Fingerprint) FromCodeSastFingerprintV1(v CodeSastFingerprintV1) error

FromCodeSastFingerprintV1 overwrites any union data inside the Fingerprint as the provided CodeSastFingerprintV1

func (*Fingerprint) FromScaProblemFingerprint 

func (t *Fingerprint) FromScaProblemFingerprint(v ScaProblemFingerprint) error

FromScaProblemFingerprint overwrites any union data inside the Fingerprint as the provided ScaProblemFingerprint

func (Fingerprint) MarshalJSON 

func (t Fingerprint) MarshalJSON() ([]byte, error)

func (*Fingerprint) MergeCodeSastFingerprintV0 

func (t *Fingerprint) MergeCodeSastFingerprintV0(v CodeSastFingerprintV0) error

MergeCodeSastFingerprintV0 performs a merge with any union data inside the Fingerprint, using the provided CodeSastFingerprintV0

func (*Fingerprint) MergeCodeSastFingerprintV1 

func (t *Fingerprint) MergeCodeSastFingerprintV1(v CodeSastFingerprintV1) error

MergeCodeSastFingerprintV1 performs a merge with any union data inside the Fingerprint, using the provided CodeSastFingerprintV1

func (*Fingerprint) MergeScaProblemFingerprint 

func (t *Fingerprint) MergeScaProblemFingerprint(v ScaProblemFingerprint) error

MergeScaProblemFingerprint performs a merge with any union data inside the Fingerprint, using the provided ScaProblemFingerprint

func (*Fingerprint) UnmarshalJSON 

func (t *Fingerprint) UnmarshalJSON(b []byte) error

func (Fingerprint) ValueByDiscriminator 

func (t Fingerprint) ValueByDiscriminator() (interface{}, error)

type GetTestParams 

type GetTestParams struct {
	// Version The API version requested.
	Version IoSnykApiRequestSnykApiRequestVersion `form:"version" json:"version"`

	// SnykRequestId A unique ID assigned to each API request, for tracing and troubleshooting.
	//
	// Snyk clients can optionally provide this ID.
	SnykRequestId *IoSnykApiRequestSnykApiRequestRequestId `json:"snyk-request-id,omitempty"`

	// SnykInteractionId Identifies the Snyk client interaction in which this API request occurs.
	//
	// The identifier is an opaque string. though at the time of writing it may either be a
	// uuid or a urn containing a uuid and some metadata.
	// to be safe, the
	SnykInteractionId *IoSnykApiRequestSnykApiRequestInteractionId `json:"snyk-interaction-id,omitempty"`
}

GetTestParams defines parameters for GetTest.

type GitCommit 

type GitCommit = string

GitCommit Git commit SHA.

type GitSCMInput 

type GitSCMInput struct {
	// Spec Git SCM import specification, which defines how to import content from a Git
	// SCM repository location into a workspace for testing, or a set of workspaces
	// for differential testing.
	Spec GitScmImportSpec `json:"spec"`
	Type GitSCMInputType  `json:"type"`
}

GitSCMInput Test input obtained from a Git SCM.

type GitSCMInputType 

type GitSCMInputType string

GitSCMInputType defines model for GitSCMInput.Type. 

const (
	GitScm GitSCMInputType = "git-scm"
)

Defines values for GitSCMInputType.

type GitScmImportSpec 

type GitScmImportSpec struct {
	// Base base is optional. If provided, it is used in supplying differential test data.
	Base *GitCommit `json:"base,omitempty"`

	// Branch branch is optional. If not provided, the default branch is used.
	Branch *string `json:"branch,omitempty"`

	// Exlude Components that should be excluded when importing the SCM contents into a Workspace.
	Exlude *[]ExcludeRule `json:"exlude,omitempty"`

	// RemoteUrl Git SCM repository URL.
	RemoteUrl string `json:"remote_url"`

	// Target target is optional. If not provided the current HEAD of the selected branch is used.
	//
	// If target is provided and branch is not, no branch metadata is associated with the test.
	// If target is provided and branch is, but target is not an ancestor of branch, the wrong
	// branch will be associated with a test. It is the caller's responsibility to ensure this is correct.
	Target *GitCommit `json:"target,omitempty"`
}

GitScmImportSpec Git SCM import specification, which defines how to import content from a Git SCM repository location into a workspace for testing, or a set of workspaces for differential testing.

type IoSnykApiCommonCollectionCounts 

type IoSnykApiCommonCollectionCounts struct {
	// Count Count of all items in the collection.
	Count uint32 `json:"count"`

	// CountBy Counts of items grouped by various dimensions.
	//
	// Outer record key is a well-known grouping dimension of the resource object.
	//
	// Inner record key is a value in that dimension.
	CountBy map[string]map[string]uint32 `json:"count_by"`
}

IoSnykApiCommonCollectionCounts CollectionCounts implements the Snyk REST API standard representation for collection counts.

Collection counts may be provided as metadata on a collection resource or in an attribute of a parent resource.

See https://snyk.roadie.so/docs/default/component/sweater-comb/standards/rest/#collection-counts.

type IoSnykApiCommonError 

type IoSnykApiCommonError struct {
	// Code An application-specific error code, expressed as a string value.
	Code *string `json:"code,omitempty"`

	// Detail A human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail"`

	// Id A unique identifier for this particular occurrence of the problem.
	Id *openapi_types.UUID `json:"id,omitempty"`

	// Links A link that leads to further details about this particular occurrance of the problem.
	Links  *IoSnykApiCommonErrorLink `json:"links,omitempty"`
	Meta   *map[string]interface{}   `json:"meta,omitempty"`
	Source *struct {
		Parameter *string `json:"parameter,omitempty"`
		Pointer   *string `json:"pointer,omitempty"`
	} `json:"source,omitempty"`

	// Status The HTTP status code applicable to this problem, expressed as a string value.
	Status string `json:"status"`

	// Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
	Title *string `json:"title,omitempty"`
}

IoSnykApiCommonError defines model for io.snyk.api.common.Error.

type IoSnykApiCommonErrorDocument 

type IoSnykApiCommonErrorDocument struct {
	Errors  []IoSnykApiCommonError `json:"errors"`
	Jsonapi IoSnykApiCommonJsonApi `json:"jsonapi"`
}

IoSnykApiCommonErrorDocument defines model for io.snyk.api.common.ErrorDocument. 

type IoSnykApiCommonErrorLink struct {
	About                *LinkProperty           `json:"about,omitempty"`
	AdditionalProperties map[string]LinkProperty `json:"-"`
}

IoSnykApiCommonErrorLink A link that leads to further details about this particular occurrance of the problem.

func (IoSnykApiCommonErrorLink) Get 

func (a IoSnykApiCommonErrorLink) Get(fieldName string) (value LinkProperty, found bool)

Getter for additional properties for IoSnykApiCommonErrorLink. Returns the specified element and whether it was found

func (IoSnykApiCommonErrorLink) MarshalJSON 

func (a IoSnykApiCommonErrorLink) MarshalJSON() ([]byte, error)

Override default JSON handling for IoSnykApiCommonErrorLink to handle AdditionalProperties

func (*IoSnykApiCommonErrorLink) Set 

func (a *IoSnykApiCommonErrorLink) Set(fieldName string, value LinkProperty)

Setter for additional properties for IoSnykApiCommonErrorLink

func (*IoSnykApiCommonErrorLink) UnmarshalJSON 

func (a *IoSnykApiCommonErrorLink) UnmarshalJSON(b []byte) error

Override default JSON handling for IoSnykApiCommonErrorLink to handle AdditionalProperties

type IoSnykApiCommonJsonApi 

type IoSnykApiCommonJsonApi struct {
	// Version Version of the JSON API specification this server supports.
	Version IoSnykApiCommonJsonApiVersion `json:"version"`
}

IoSnykApiCommonJsonApi defines model for io.snyk.api.common.JsonApi.

type IoSnykApiCommonJsonApiVersion 

type IoSnykApiCommonJsonApiVersion string

IoSnykApiCommonJsonApiVersion Version of the JSON API specification this server supports. 

const (
	N10 IoSnykApiCommonJsonApiVersion = "1.0"
)

Defines values for IoSnykApiCommonJsonApiVersion.

type IoSnykApiCommonLinkObject 

type IoSnykApiCommonLinkObject struct {
	Href IoSnykApiCommonLinkString `json:"href"`

	// Meta Free-form object that may contain non-standard information.
	Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
}

IoSnykApiCommonLinkObject defines model for io.snyk.api.common.LinkObject.

type IoSnykApiCommonLinkString 

type IoSnykApiCommonLinkString = string

IoSnykApiCommonLinkString defines model for io.snyk.api.common.LinkString.

type IoSnykApiCommonMeta 

type IoSnykApiCommonMeta map[string]interface{}

IoSnykApiCommonMeta Free-form object that may contain non-standard information. 

type IoSnykApiCommonPaginatedLinks struct {
	First *LinkProperty `json:"first,omitempty"`
	Last  *LinkProperty `json:"last,omitempty"`
	Next  *LinkProperty `json:"next,omitempty"`
	Prev  *LinkProperty `json:"prev,omitempty"`
	Self  *LinkProperty `json:"self,omitempty"`
}

IoSnykApiCommonPaginatedLinks defines model for io.snyk.api.common.PaginatedLinks. 

type IoSnykApiCommonRelatedLink struct {
	Related *LinkProperty `json:"related,omitempty"`
}

IoSnykApiCommonRelatedLink defines model for io.snyk.api.common.RelatedLink.

type IoSnykApiRequestPaginatedRequestEndingBefore 

type IoSnykApiRequestPaginatedRequestEndingBefore = string

IoSnykApiRequestPaginatedRequestEndingBefore defines model for io.snyk.api.request.PaginatedRequest.ending_before.

type IoSnykApiRequestPaginatedRequestLimit 

type IoSnykApiRequestPaginatedRequestLimit = int8

IoSnykApiRequestPaginatedRequestLimit defines model for io.snyk.api.request.PaginatedRequest.limit.

type IoSnykApiRequestPaginatedRequestStartingAfter 

type IoSnykApiRequestPaginatedRequestStartingAfter = string

IoSnykApiRequestPaginatedRequestStartingAfter defines model for io.snyk.api.request.PaginatedRequest.starting_after.

type IoSnykApiRequestSnykApiRequestInteractionId 

type IoSnykApiRequestSnykApiRequestInteractionId = string

IoSnykApiRequestSnykApiRequestInteractionId defines model for io.snyk.api.request.SnykApiRequest.interactionId.

type IoSnykApiRequestSnykApiRequestRequestId 

type IoSnykApiRequestSnykApiRequestRequestId = openapi_types.UUID

IoSnykApiRequestSnykApiRequestRequestId defines model for io.snyk.api.request.SnykApiRequest.requestId.

type IoSnykApiRequestSnykApiRequestVersion 

type IoSnykApiRequestSnykApiRequestVersion = string

IoSnykApiRequestSnykApiRequestVersion defines model for io.snyk.api.request.SnykApiRequest.version.

type LegacyDeepcodeBundleAddress 

type LegacyDeepcodeBundleAddress struct {
	// BundleId Legacy Deepcode bundle ID is a sha256 sum (64 hex digits).
	BundleId string                            `json:"bundle_id"`
	Scheme   LegacyDeepcodeBundleAddressScheme `json:"scheme"`
}

LegacyDeepcodeBundleAddress Legacy Deepcode API bundle.

This is provided provisionally for compatibility purposes.

type LegacyDeepcodeBundleAddressScheme 

type LegacyDeepcodeBundleAddressScheme string

LegacyDeepcodeBundleAddressScheme defines model for LegacyDeepcodeBundleAddress.Scheme. 

const (
	DeepcodeBundle LegacyDeepcodeBundleAddressScheme = "deepcode-bundle"
)

Defines values for LegacyDeepcodeBundleAddressScheme.

type LinkProperty 

type LinkProperty struct {
	// contains filtered or unexported fields
}

LinkProperty defines model for LinkProperty.

func (LinkProperty) AsIoSnykApiCommonLinkObject 

func (t LinkProperty) AsIoSnykApiCommonLinkObject() (IoSnykApiCommonLinkObject, error)

AsIoSnykApiCommonLinkObject returns the union data inside the LinkProperty as a IoSnykApiCommonLinkObject

func (LinkProperty) AsIoSnykApiCommonLinkString 

func (t LinkProperty) AsIoSnykApiCommonLinkString() (IoSnykApiCommonLinkString, error)

AsIoSnykApiCommonLinkString returns the union data inside the LinkProperty as a IoSnykApiCommonLinkString

func (*LinkProperty) FromIoSnykApiCommonLinkObject 

func (t *LinkProperty) FromIoSnykApiCommonLinkObject(v IoSnykApiCommonLinkObject) error

FromIoSnykApiCommonLinkObject overwrites any union data inside the LinkProperty as the provided IoSnykApiCommonLinkObject

func (*LinkProperty) FromIoSnykApiCommonLinkString 

func (t *LinkProperty) FromIoSnykApiCommonLinkString(v IoSnykApiCommonLinkString) error

FromIoSnykApiCommonLinkString overwrites any union data inside the LinkProperty as the provided IoSnykApiCommonLinkString

func (LinkProperty) MarshalJSON 

func (t LinkProperty) MarshalJSON() ([]byte, error)

func (*LinkProperty) MergeIoSnykApiCommonLinkObject 

func (t *LinkProperty) MergeIoSnykApiCommonLinkObject(v IoSnykApiCommonLinkObject) error

MergeIoSnykApiCommonLinkObject performs a merge with any union data inside the LinkProperty, using the provided IoSnykApiCommonLinkObject

func (*LinkProperty) MergeIoSnykApiCommonLinkString 

func (t *LinkProperty) MergeIoSnykApiCommonLinkString(v IoSnykApiCommonLinkString) error

MergeIoSnykApiCommonLinkString performs a merge with any union data inside the LinkProperty, using the provided IoSnykApiCommonLinkString

func (*LinkProperty) UnmarshalJSON 

func (t *LinkProperty) UnmarshalJSON(b []byte) error

type ListFindingsParams 

type ListFindingsParams struct {
	// Version The API version requested.
	Version IoSnykApiRequestSnykApiRequestVersion `form:"version" json:"version"`

	// StartingAfter Opaque pagination cursor for forward traversal.
	StartingAfter *IoSnykApiRequestPaginatedRequestStartingAfter `form:"starting_after,omitempty" json:"starting_after,omitempty"`

	// EndingBefore Opaque pagination cursor for reverse traversal.
	EndingBefore *IoSnykApiRequestPaginatedRequestEndingBefore `form:"ending_before,omitempty" json:"ending_before,omitempty"`

	// Limit The number of items to return.
	Limit *IoSnykApiRequestPaginatedRequestLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// SnykRequestId A unique ID assigned to each API request, for tracing and troubleshooting.
	//
	// Snyk clients can optionally provide this ID.
	SnykRequestId *IoSnykApiRequestSnykApiRequestRequestId `json:"snyk-request-id,omitempty"`

	// SnykInteractionId Identifies the Snyk client interaction in which this API request occurs.
	//
	// The identifier is an opaque string. though at the time of writing it may either be a
	// uuid or a urn containing a uuid and some metadata.
	// to be safe, the
	SnykInteractionId *IoSnykApiRequestSnykApiRequestInteractionId `json:"snyk-interaction-id,omitempty"`
}

ListFindingsParams defines parameters for ListFindings.

type LocalFinding 

type LocalFinding struct {
	Findings []FindingResource `json:"findings"`
	Summary  FindingsSummary   `json:"summary"`
	Outcome  TestOutcome       `json:"outcome"`
}

TODO: This schema should be imported from Dragonfly

type ObjectExcludeRule 

type ObjectExcludeRule struct {
	// contains filtered or unexported fields
}

ObjectExcludeRule defines model for ObjectExcludeRule.

func (ObjectExcludeRule) AsFileObjectExcludeRule 

func (t ObjectExcludeRule) AsFileObjectExcludeRule() (FileObjectExcludeRule, error)

AsFileObjectExcludeRule returns the union data inside the ObjectExcludeRule as a FileObjectExcludeRule

func (ObjectExcludeRule) AsOtherObjectExcludeRule 

func (t ObjectExcludeRule) AsOtherObjectExcludeRule() (OtherObjectExcludeRule, error)

AsOtherObjectExcludeRule returns the union data inside the ObjectExcludeRule as a OtherObjectExcludeRule

func (ObjectExcludeRule) Discriminator 

func (t ObjectExcludeRule) Discriminator() (string, error)

func (*ObjectExcludeRule) FromFileObjectExcludeRule 

func (t *ObjectExcludeRule) FromFileObjectExcludeRule(v FileObjectExcludeRule) error

FromFileObjectExcludeRule overwrites any union data inside the ObjectExcludeRule as the provided FileObjectExcludeRule

func (*ObjectExcludeRule) FromOtherObjectExcludeRule 

func (t *ObjectExcludeRule) FromOtherObjectExcludeRule(v OtherObjectExcludeRule) error

FromOtherObjectExcludeRule overwrites any union data inside the ObjectExcludeRule as the provided OtherObjectExcludeRule

func (ObjectExcludeRule) MarshalJSON 

func (t ObjectExcludeRule) MarshalJSON() ([]byte, error)

func (*ObjectExcludeRule) MergeFileObjectExcludeRule 

func (t *ObjectExcludeRule) MergeFileObjectExcludeRule(v FileObjectExcludeRule) error

MergeFileObjectExcludeRule performs a merge with any union data inside the ObjectExcludeRule, using the provided FileObjectExcludeRule

func (*ObjectExcludeRule) MergeOtherObjectExcludeRule 

func (t *ObjectExcludeRule) MergeOtherObjectExcludeRule(v OtherObjectExcludeRule) error

MergeOtherObjectExcludeRule performs a merge with any union data inside the ObjectExcludeRule, using the provided OtherObjectExcludeRule

func (*ObjectExcludeRule) UnmarshalJSON 

func (t *ObjectExcludeRule) UnmarshalJSON(b []byte) error

func (ObjectExcludeRule) ValueByDiscriminator 

func (t ObjectExcludeRule) ValueByDiscriminator() (interface{}, error)

type OrgIdParam 

type OrgIdParam = openapi_types.UUID

OrgIdParam defines model for OrgIdParam.

type OtherObjectExcludeRule 

type OtherObjectExcludeRule struct {
	Type                 OtherObjectExcludeRuleType `json:"type"`
	AdditionalProperties map[string]interface{}     `json:"-"`
}

OtherObjectExcludeRule OtherObjectExludeRule is a placeholder expansion value, for when types of exclusion rules were used in testing that are not present in the called version of the API.

func (OtherObjectExcludeRule) Get 

func (a OtherObjectExcludeRule) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for OtherObjectExcludeRule. Returns the specified element and whether it was found

func (OtherObjectExcludeRule) MarshalJSON 

func (a OtherObjectExcludeRule) MarshalJSON() ([]byte, error)

Override default JSON handling for OtherObjectExcludeRule to handle AdditionalProperties

func (*OtherObjectExcludeRule) Set 

func (a *OtherObjectExcludeRule) Set(fieldName string, value interface{})

Setter for additional properties for OtherObjectExcludeRule

func (*OtherObjectExcludeRule) UnmarshalJSON 

func (a *OtherObjectExcludeRule) UnmarshalJSON(b []byte) error

Override default JSON handling for OtherObjectExcludeRule to handle AdditionalProperties

type OtherObjectExcludeRuleType 

type OtherObjectExcludeRuleType string

OtherObjectExcludeRuleType defines model for OtherObjectExcludeRule.Type. 

const (
	OtherObjectExcludeRuleTypeOther OtherObjectExcludeRuleType = "other"
)

Defines values for OtherObjectExcludeRuleType.

type Package 

type Package struct {
	// contains filtered or unexported fields
}

Package A Package is either a Package URL (pURL) or a decomposed PackageObject identifying a software package.

See https://github.com/package-url/purl-spec for more information about pURLs.

func (Package) AsPackageObject 

func (t Package) AsPackageObject() (PackageObject, error)

AsPackageObject returns the union data inside the Package as a PackageObject

func (Package) AsPackageURL 

func (t Package) AsPackageURL() (PackageURL, error)

AsPackageURL returns the union data inside the Package as a PackageURL

func (*Package) FromPackageObject 

func (t *Package) FromPackageObject(v PackageObject) error

FromPackageObject overwrites any union data inside the Package as the provided PackageObject

func (*Package) FromPackageURL 

func (t *Package) FromPackageURL(v PackageURL) error

FromPackageURL overwrites any union data inside the Package as the provided PackageURL

func (Package) MarshalJSON 

func (t Package) MarshalJSON() ([]byte, error)

func (*Package) MergePackageObject 

func (t *Package) MergePackageObject(v PackageObject) error

MergePackageObject performs a merge with any union data inside the Package, using the provided PackageObject

func (*Package) MergePackageURL 

func (t *Package) MergePackageURL(v PackageURL) error

MergePackageURL performs a merge with any union data inside the Package, using the provided PackageURL

func (*Package) UnmarshalJSON 

func (t *Package) UnmarshalJSON(b []byte) error

type PackageObject 

type PackageObject struct {
	// Meta Free-form metadata about this package.
	Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`

	// Name Package name, possibly with a namespace prefix.
	Name string `json:"name"`

	// Root Package management system root location.
	//
	// If set, isolates the package to a private ecosystem repository.
	//
	// Defaults to "the canonical public ecosystem repository root" for the package ecosystem type.
	Root *string `json:"root,omitempty"`

	// Subpath Sub-package qualifier, if applicable.
	Subpath *string `json:"subpath,omitempty"`

	// Type Package management system or ecosystem type.
	Type string `json:"type"`

	// Version Package version. One would hope this is semver but this generally depends
	// on the ecosystem and its package standards and requirements.
	Version string `json:"version"`
}

PackageObject PackageObject represents a decomposed Package URL, enriched with a resolved package repository root location. This disambiguates public packages from private packages in security SCA and remediation.

type PackageURL 

type PackageURL = string

PackageURL Package information represented in Package URL (pURL) form.

type RiskFactors 

type RiskFactors struct {
	// contains filtered or unexported fields
}

RiskFactors defines model for RiskFactors.

func (RiskFactors) AsBusinessCriticalityRiskFactor 

func (t RiskFactors) AsBusinessCriticalityRiskFactor() (BusinessCriticalityRiskFactor, error)

AsBusinessCriticalityRiskFactor returns the union data inside the RiskFactors as a BusinessCriticalityRiskFactor

func (RiskFactors) AsCvssRiskFactor 

func (t RiskFactors) AsCvssRiskFactor() (CvssRiskFactor, error)

AsCvssRiskFactor returns the union data inside the RiskFactors as a CvssRiskFactor

func (RiskFactors) AsEpssRiskFactor 

func (t RiskFactors) AsEpssRiskFactor() (EpssRiskFactor, error)

AsEpssRiskFactor returns the union data inside the RiskFactors as a EpssRiskFactor

func (RiskFactors) AsVulnerabilityFactRiskFactor 

func (t RiskFactors) AsVulnerabilityFactRiskFactor() (VulnerabilityFactRiskFactor, error)

AsVulnerabilityFactRiskFactor returns the union data inside the RiskFactors as a VulnerabilityFactRiskFactor

func (RiskFactors) AsVulnerabilityInstanceFactRiskFactor 

func (t RiskFactors) AsVulnerabilityInstanceFactRiskFactor() (VulnerabilityInstanceFactRiskFactor, error)

AsVulnerabilityInstanceFactRiskFactor returns the union data inside the RiskFactors as a VulnerabilityInstanceFactRiskFactor

func (RiskFactors) Discriminator 

func (t RiskFactors) Discriminator() (string, error)

func (*RiskFactors) FromBusinessCriticalityRiskFactor 

func (t *RiskFactors) FromBusinessCriticalityRiskFactor(v BusinessCriticalityRiskFactor) error

FromBusinessCriticalityRiskFactor overwrites any union data inside the RiskFactors as the provided BusinessCriticalityRiskFactor

func (*RiskFactors) FromCvssRiskFactor 

func (t *RiskFactors) FromCvssRiskFactor(v CvssRiskFactor) error

FromCvssRiskFactor overwrites any union data inside the RiskFactors as the provided CvssRiskFactor

func (*RiskFactors) FromEpssRiskFactor 

func (t *RiskFactors) FromEpssRiskFactor(v EpssRiskFactor) error

FromEpssRiskFactor overwrites any union data inside the RiskFactors as the provided EpssRiskFactor

func (*RiskFactors) FromVulnerabilityFactRiskFactor 

func (t *RiskFactors) FromVulnerabilityFactRiskFactor(v VulnerabilityFactRiskFactor) error

FromVulnerabilityFactRiskFactor overwrites any union data inside the RiskFactors as the provided VulnerabilityFactRiskFactor

func (*RiskFactors) FromVulnerabilityInstanceFactRiskFactor 

func (t *RiskFactors) FromVulnerabilityInstanceFactRiskFactor(v VulnerabilityInstanceFactRiskFactor) error

FromVulnerabilityInstanceFactRiskFactor overwrites any union data inside the RiskFactors as the provided VulnerabilityInstanceFactRiskFactor

func (RiskFactors) MarshalJSON 

func (t RiskFactors) MarshalJSON() ([]byte, error)

func (*RiskFactors) MergeBusinessCriticalityRiskFactor 

func (t *RiskFactors) MergeBusinessCriticalityRiskFactor(v BusinessCriticalityRiskFactor) error

MergeBusinessCriticalityRiskFactor performs a merge with any union data inside the RiskFactors, using the provided BusinessCriticalityRiskFactor

func (*RiskFactors) MergeCvssRiskFactor 

func (t *RiskFactors) MergeCvssRiskFactor(v CvssRiskFactor) error

MergeCvssRiskFactor performs a merge with any union data inside the RiskFactors, using the provided CvssRiskFactor

func (*RiskFactors) MergeEpssRiskFactor 

func (t *RiskFactors) MergeEpssRiskFactor(v EpssRiskFactor) error

MergeEpssRiskFactor performs a merge with any union data inside the RiskFactors, using the provided EpssRiskFactor

func (*RiskFactors) MergeVulnerabilityFactRiskFactor 

func (t *RiskFactors) MergeVulnerabilityFactRiskFactor(v VulnerabilityFactRiskFactor) error

MergeVulnerabilityFactRiskFactor performs a merge with any union data inside the RiskFactors, using the provided VulnerabilityFactRiskFactor

func (*RiskFactors) MergeVulnerabilityInstanceFactRiskFactor 

func (t *RiskFactors) MergeVulnerabilityInstanceFactRiskFactor(v VulnerabilityInstanceFactRiskFactor) error

MergeVulnerabilityInstanceFactRiskFactor performs a merge with any union data inside the RiskFactors, using the provided VulnerabilityInstanceFactRiskFactor

func (*RiskFactors) UnmarshalJSON 

func (t *RiskFactors) UnmarshalJSON(b []byte) error

func (RiskFactors) ValueByDiscriminator 

func (t RiskFactors) ValueByDiscriminator() (interface{}, error)

type ScaPackage 

type ScaPackage struct {
	PackageName    string `json:"package_name"`
	PackageVersion string `json:"package_version"`
}

ScaPackage defines model for ScaPackage.

type ScaProblemFingerprint 

type ScaProblemFingerprint struct {
	Scheme ScaProblemFingerprintScheme `json:"scheme"`
	Value  string                      `json:"value"`
}

ScaProblemFingerprint defines model for ScaProblemFingerprint.

type ScaProblemFingerprintScheme 

type ScaProblemFingerprintScheme string

ScaProblemFingerprintScheme defines model for ScaProblemFingerprint.Scheme. 

const (
	ScaProblem ScaProblemFingerprintScheme = "sca-problem"
)

Defines values for ScaProblemFingerprintScheme.

type ScanType 

type ScanType string

ScanType Security scan type. The scan type determines what types of attributes one might expect to find in the finding. 

const (
	ScanTypeOther ScanType = "other"
	ScanTypeSast  ScanType = "sast"
	ScanTypeSca   ScanType = "sca"
)

Defines values for ScanType.

type SuggestedOther 

type SuggestedOther struct {
	Type                 SuggestedOtherType     `json:"type"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

SuggestedOther SuggestedOther that aren't yet defined in this API version.

func (SuggestedOther) Get 

func (a SuggestedOther) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for SuggestedOther. Returns the specified element and whether it was found

func (SuggestedOther) MarshalJSON 

func (a SuggestedOther) MarshalJSON() ([]byte, error)

Override default JSON handling for SuggestedOther to handle AdditionalProperties

func (*SuggestedOther) Set 

func (a *SuggestedOther) Set(fieldName string, value interface{})

Setter for additional properties for SuggestedOther

func (*SuggestedOther) UnmarshalJSON 

func (a *SuggestedOther) UnmarshalJSON(b []byte) error

Override default JSON handling for SuggestedOther to handle AdditionalProperties

type SuggestedOtherType 

type SuggestedOtherType string

SuggestedOtherType defines model for SuggestedOther.Type. 

const (
	SuggestedOtherTypeOther SuggestedOtherType = "other"
)

Defines values for SuggestedOtherType.

type SuggestedPackageUpgrade 

type SuggestedPackageUpgrade struct {
	// CurrentPackage Affected package.
	CurrentPackage Package                     `json:"current_package"`
	Type           SuggestedPackageUpgradeType `json:"type"`

	// UpgradeConflicts Indicate whether the upgrade version is known to conflict with other
	// dependencies on the same package.
	//
	// If false, the upgrade does not conflict and should be applicable.
	//
	// If null or missing, conflict status is unknown or was not calculated;
	// applying the upgrade could fail.
	UpgradeConflicts *SuggestedPackageUpgradeUpgradeConflicts `json:"upgrade_conflicts"`

	// UpgradePackage Upgrade package in which the vulnerability is no longer present.
	//
	// If unset, no upgrade version is available.
	UpgradePackage *Package `json:"upgrade_package,omitempty"`
}

SuggestedPackageUpgrade SuggestedPackageUpgrade provides some basic information on how to mitigate an SCA finding in a managed package ecosystem with an upgrade.

The upgrade does not take into account other dependency paths to the affected package which may have conflicting constraints. The upgrade version may introduce other vulnerabilities. This is the main difference between a suggestion and a remediation.

For a comprehensive mitigation with satisfiability and security guarantees, the remediation relation should be used.

If conflicts are known to exist this may be reported, but the absense of this flag should not be taken as a guarantee conflicts will not be encountered. It only means the conflict status is unknown.

type SuggestedPackageUpgradeType 

type SuggestedPackageUpgradeType string

SuggestedPackageUpgradeType defines model for SuggestedPackageUpgrade.Type. 

const (
	PackageUpgrade SuggestedPackageUpgradeType = "package-upgrade"
)

Defines values for SuggestedPackageUpgradeType.

type SuggestedPackageUpgradeUpgradeConflicts 

type SuggestedPackageUpgradeUpgradeConflicts bool

SuggestedPackageUpgradeUpgradeConflicts Indicate whether the upgrade version is known to conflict with other dependencies on the same package.

If false, the upgrade does not conflict and should be applicable.

If null or missing, conflict status is unknown or was not calculated; applying the upgrade could fail. 

const (
	False SuggestedPackageUpgradeUpgradeConflicts = false
	True  SuggestedPackageUpgradeUpgradeConflicts = true
)

Defines values for SuggestedPackageUpgradeUpgradeConflicts.

type Suggestion 

type Suggestion struct {
	// contains filtered or unexported fields
}

Suggestion Suggestions are indications given to the user that might help with mitigating the finding.

func (Suggestion) AsSuggestedOther 

func (t Suggestion) AsSuggestedOther() (SuggestedOther, error)

AsSuggestedOther returns the union data inside the Suggestion as a SuggestedOther

func (Suggestion) AsSuggestedPackageUpgrade 

func (t Suggestion) AsSuggestedPackageUpgrade() (SuggestedPackageUpgrade, error)

AsSuggestedPackageUpgrade returns the union data inside the Suggestion as a SuggestedPackageUpgrade

func (Suggestion) Discriminator 

func (t Suggestion) Discriminator() (string, error)

func (*Suggestion) FromSuggestedOther 

func (t *Suggestion) FromSuggestedOther(v SuggestedOther) error

FromSuggestedOther overwrites any union data inside the Suggestion as the provided SuggestedOther

func (*Suggestion) FromSuggestedPackageUpgrade 

func (t *Suggestion) FromSuggestedPackageUpgrade(v SuggestedPackageUpgrade) error

FromSuggestedPackageUpgrade overwrites any union data inside the Suggestion as the provided SuggestedPackageUpgrade

func (Suggestion) MarshalJSON 

func (t Suggestion) MarshalJSON() ([]byte, error)

func (*Suggestion) MergeSuggestedOther 

func (t *Suggestion) MergeSuggestedOther(v SuggestedOther) error

MergeSuggestedOther performs a merge with any union data inside the Suggestion, using the provided SuggestedOther

func (*Suggestion) MergeSuggestedPackageUpgrade 

func (t *Suggestion) MergeSuggestedPackageUpgrade(v SuggestedPackageUpgrade) error

MergeSuggestedPackageUpgrade performs a merge with any union data inside the Suggestion, using the provided SuggestedPackageUpgrade

func (*Suggestion) UnmarshalJSON 

func (t *Suggestion) UnmarshalJSON(b []byte) error

func (Suggestion) ValueByDiscriminator 

func (t Suggestion) ValueByDiscriminator() (interface{}, error)

type Suppression 

type Suppression struct {
	Justification *string         `json:"justification,omitempty"`
	Kind          SuppressionKind `json:"kind"`
}

Suppression Reasons for why a Finding can be suppressed from a Test result. This MAY NOT be required at all, given the presentation

type SuppressionKind 

type SuppressionKind string

SuppressionKind defines model for Suppression.Kind. 

const (
	SuppressionKindIgnored               SuppressionKind = "ignored"
	SuppressionKindOther                 SuppressionKind = "other"
	SuppressionKindPendingIgnoreApproval SuppressionKind = "pending_ignore_approval"
)

Defines values for SuppressionKind.

type TestContext 

type TestContext struct {
	// GitScmBranch Git SCM branch associated with the content, if known.
	//
	// This allows providing the Git SCM branch as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on a feature branch.
	GitScmBranch *string `json:"git_scm_branch,omitempty"`

	// GitScmUrl Git SCM URL associated with the content, if known.
	//
	// This allows providing the Git SCM URL as context in cases where the input
	// is not directly imported from a Git SCM repository.
	//
	// For example, a developer working in an IDE on source code which was cloned
	// from, and will be proposed for merging back into, an SCM repository.
	GitScmUrl *string `json:"git_scm_url,omitempty"`

	// SdlcStage Indicate at which point in the SDLC lifecycle the test was executed.
	// `other` is returned if the test was created with a newer version of
	// the API including a new SDLC stage, not supported in the version of
	// the API used for retrieval.
	SdlcStage TestContextSdlcStage `json:"sdlc_stage"`
}

TestContext TestContext identifies the context in which this Test occurs.

type TestContextSdlcStage 

type TestContextSdlcStage string

TestContextSdlcStage Indicate at which point in the SDLC lifecycle the test was executed. `other` is returned if the test was created with a newer version of the API including a new SDLC stage, not supported in the version of the API used for retrieval. 

const (
	TestContextSdlcStageCicd      TestContextSdlcStage = "cicd"
	TestContextSdlcStageDev       TestContextSdlcStage = "dev"
	TestContextSdlcStageOther     TestContextSdlcStage = "other"
	TestContextSdlcStagePrcheck   TestContextSdlcStage = "prcheck"
	TestContextSdlcStageRecurring TestContextSdlcStage = "recurring"
)

Defines values for TestContextSdlcStage.

type TestError 

type TestError struct {
	// Code Error code, references Snyk error catalog.
	Code string `json:"code"`

	// Links Links to error detail information.
	Links *IoSnykApiCommonErrorLink `json:"links,omitempty"`

	// Meta Free-form metadata associated with the error.
	Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`

	// Reason Descriptive reason for the error.
	Reason *string `json:"reason,omitempty"`
}

TestError An error that occurred during a Test.

type TestExecStatus 

type TestExecStatus string

TestExecStatus defines model for TestExecStatus. 

const (
	Done    TestExecStatus = "done"
	Pending TestExecStatus = "pending"
	Running TestExecStatus = "running"
)

Defines values for TestExecStatus.

type TestIdParam 

type TestIdParam = openapi_types.UUID

TestIdParam defines model for TestIdParam.

type TestInput 

type TestInput struct {
	// contains filtered or unexported fields
}

TestInput TestInput defines what will be tested.

Another term for this might be "test coordinates".

func (TestInput) AsContentAddressInput 

func (t TestInput) AsContentAddressInput() (ContentAddressInput, error)

AsContentAddressInput returns the union data inside the TestInput as a ContentAddressInput

func (TestInput) AsGitSCMInput 

func (t TestInput) AsGitSCMInput() (GitSCMInput, error)

AsGitSCMInput returns the union data inside the TestInput as a GitSCMInput

func (TestInput) Discriminator 

func (t TestInput) Discriminator() (string, error)

func (*TestInput) FromContentAddressInput 

func (t *TestInput) FromContentAddressInput(v ContentAddressInput) error

FromContentAddressInput overwrites any union data inside the TestInput as the provided ContentAddressInput

func (*TestInput) FromGitSCMInput 

func (t *TestInput) FromGitSCMInput(v GitSCMInput) error

FromGitSCMInput overwrites any union data inside the TestInput as the provided GitSCMInput

func (TestInput) MarshalJSON 

func (t TestInput) MarshalJSON() ([]byte, error)

func (*TestInput) MergeContentAddressInput 

func (t *TestInput) MergeContentAddressInput(v ContentAddressInput) error

MergeContentAddressInput performs a merge with any union data inside the TestInput, using the provided ContentAddressInput

func (*TestInput) MergeGitSCMInput 

func (t *TestInput) MergeGitSCMInput(v GitSCMInput) error

MergeGitSCMInput performs a merge with any union data inside the TestInput, using the provided GitSCMInput

func (*TestInput) UnmarshalJSON 

func (t *TestInput) UnmarshalJSON(b []byte) error

func (TestInput) ValueByDiscriminator 

func (t TestInput) ValueByDiscriminator() (interface{}, error)

type TestOptions 

type TestOptions struct {
	// Exclude Files from which findings should be excluded and removed from
	// results.
	//
	// This is different from FindingAttributes.suppressions; the exclude is an
	// up-front declaration that findings in the excluded files are
	// immaterial to the test result (pass/fail), and should not be reported at all.
	//
	// Excluded files might still be used to link other files/findings though. For
	// example, a SAST (source-to-sink) or SCA analysis (transitive dependency
	// chain) might transit an excluded file, enabling discovery in a
	// non-excluded file.
	Exclude *[]ExcludeRule `json:"exclude,omitempty"`
}

TestOptions TestOptions defines options which determine how the Test is conducted. In includes the fields used in create test options, but in a backwards compatible manner.

type TestOutcome 

type TestOutcome struct {
	Reason *TestOutcomeReason `json:"reason,omitempty"`
	Result TestOutcomeResult  `json:"result"`
}

TestOutcome The outcome of a Test; pass or fail. It is possible for the Test to show failure before the overall status has completed.

type TestOutcomeReason 

type TestOutcomeReason string

TestOutcomeReason defines model for TestOutcome.Reason. 

const (
	Other        TestOutcomeReason = "other"
	PolicyBreach TestOutcomeReason = "policy_breach"
	Timeout      TestOutcomeReason = "timeout"
)

Defines values for TestOutcomeReason.

type TestOutcomeResult 

type TestOutcomeResult string

TestOutcomeResult defines model for TestOutcome.Result. 

const (
	Fail TestOutcomeResult = "fail"
	Pass TestOutcomeResult = "pass"
)

Defines values for TestOutcomeResult.

type TestRelationships 

type TestRelationships struct {
	// Findings Relationship link to the findings collection for this test.
	Findings struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"findings"`

	// Logs Relate to application-facing logs produced by the test.
	Logs *struct {
		Data *struct {
			Id   openapi_types.UUID `json:"id"`
			Type string             `json:"type"`
		} `json:"data,omitempty"`
		Links IoSnykApiCommonRelatedLink `json:"links"`

		// Meta Free-form object that may contain non-standard information.
		Meta *IoSnykApiCommonMeta `json:"meta,omitempty"`
	} `json:"logs,omitempty"`
}

TestRelationships Resources related to a test.

type TestResource 

type TestResource struct {
	// Attributes Summary-level attributes of a test.
	Attributes struct {
		// Context Test context; pertinent information important to associate with the outcome
		// of the test and its further processing, but is not directly used in the
		// test.
		//
		// These are worth modeling with a concrete type, rather than as generic
		// free-form metadata to communicate to consumers of the test what values are
		// available.
		Context *TestContext `json:"context,omitempty"`

		// Options TestOptions are arguments which were used to configure the test and determine the
		// behavior of how it is conducted.
		//
		// Options are optional when creating a test and may be derived from other
		// sources, such as a test configuration policy if not specified. Provided
		// options may be merged with or overridden by such policy.
		//
		// In the requested Test resource, these options will reflect the effective
		// options resolved and applied to the execution of the test.
		Options *TestOptions `json:"options,omitempty"`

		// Outcome Overall outcome of the security test: pass or fail.
		//
		// This outcome may indicate failure early even while the test is still
		// running to completion.
		Outcome TestOutcome `json:"outcome"`

		// State State of the test, which should be polled to status "running" or "done"
		// before unmarshaling into this type.
		State TestState `json:"state"`

		// Summary Summary of all the findings discovered by all the security scans conducted
		// for this test.
		Summary FindingsSummary `json:"summary"`
	} `json:"attributes"`

	// Id Test resource ID. A unique ID assigned to each created test.
	Id openapi_types.UUID `json:"id"`

	// Relationships Resources related to a test.
	Relationships TestRelationships `json:"relationships"`

	// Type Test resource type.
	Type TestResourceType `json:"type"`
}

TestResource TestResource models a JSON API Test resource.

type TestResourceType 

type TestResourceType string

TestResourceType Test resource type. 

const (
	Tests TestResourceType = "tests"
)

Defines values for TestResourceType.

type TestState 

type TestState struct {
	// Errors Errors that occurred during the test execution.
	Errors *TestError `json:"errors,omitempty"`

	// Status Test execution status.
	Status TestExecStatus `json:"status"`
}

TestState The state of a Test execution. Does not include the pass or fail.

type VulnerabilityFactRiskFactor 

type VulnerabilityFactRiskFactor struct {
	Factor VulnerabilityFactRiskFactorFactor `json:"factor"`
	Name   string                            `json:"name"`
	Value  bool                              `json:"value"`
}

VulnerabilityFactRiskFactor defines model for VulnerabilityFactRiskFactor.

type VulnerabilityFactRiskFactorFactor 

type VulnerabilityFactRiskFactorFactor string

VulnerabilityFactRiskFactorFactor defines model for VulnerabilityFactRiskFactor.Factor. 

const (
	VulnerabilityFact VulnerabilityFactRiskFactorFactor = "vulnerability-fact"
)

Defines values for VulnerabilityFactRiskFactorFactor.

type VulnerabilityInstanceFactRiskFactor 

type VulnerabilityInstanceFactRiskFactor struct {
	Factor VulnerabilityInstanceFactRiskFactorFactor `json:"factor"`
	Name   string                                    `json:"name"`
	Value  bool                                      `json:"value"`
}

VulnerabilityInstanceFactRiskFactor defines model for VulnerabilityInstanceFactRiskFactor.

type VulnerabilityInstanceFactRiskFactorFactor 

type VulnerabilityInstanceFactRiskFactorFactor string

VulnerabilityInstanceFactRiskFactorFactor defines model for VulnerabilityInstanceFactRiskFactor.Factor. 

const (
	VulnerabilityInstanceFact VulnerabilityInstanceFactRiskFactorFactor = "vulnerability-instance-fact"
)

Defines values for VulnerabilityInstanceFactRiskFactorFactor.

type WorkspaceV1Address 

type WorkspaceV1Address struct {
	Scheme WorkspaceV1AddressScheme `json:"scheme"`

	// WorkspaceId Workspace v1 is a sha256 sum (64 hex digits).
	WorkspaceId string `json:"workspace_id"`
}

WorkspaceV1Address Workspace v1 content storage address.

TODO: Update this as needed.

type WorkspaceV1AddressScheme 

type WorkspaceV1AddressScheme string

WorkspaceV1AddressScheme defines model for WorkspaceV1Address.Scheme. 

const (
	WorkspaceV1 WorkspaceV1AddressScheme = "workspace-v1"
)

Defines values for WorkspaceV1AddressScheme.

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.