models

type APIEndpoint struct {

	// Api Id
	//
	// API service this endpoint belongs to. Empty if still undetermined.
	// Format: uuid
	APIID strfmt.UUID `json:"api_id,omitempty"`

	// compliance
	Compliance *APIServiceComplianceSimple `json:"compliance,omitempty"`

	// Host
	//
	// IP v4/v6 address of the API endpoint
	// Required: true
	Host *string `json:"host"`

	// Hostname
	//
	// Hostname of the API endpoint if known
	Hostname string `json:"hostname,omitempty"`

	// id
	//
	// Unique id of the Endpoint
	// Required: true
	// Format: uuid
	Identifier *strfmt.UUID `json:"identifier"`

	// Location
	Location string `json:"location,omitempty"`

	// Port
	//
	// Port of the API endpoint
	// Required: true
	// Maximum: 65535
	// Minimum: 0
	Port *int64 `json:"port"`

	// proto
	// Required: true
	Proto *IPProtoEnum `json:"proto"`

	// scheme
	Scheme URLSchemeEnum `json:"scheme,omitempty"`
}

type APIEndpointScoreGrade struct {

	// Additional Info
	AdditionalInfo []*AdditionalInfo `json:"additional_info"`

	// Categories
	// Required: true
	Categories map[string]CategoryScoreGrade `json:"categories"`

	// confidence
	Confidence RiskConfidenceEnum `json:"confidence,omitempty"`

	// counters history
	CountersHistory *CountersHistory `json:"counters_history,omitempty"`

	// endpoint
	// Required: true
	Endpoint *APIEndpoint `json:"endpoint"`

	// endpoint id
	// Format: uuid
	EndpointID strfmt.UUID `json:"endpoint_id,omitempty"`

	// risk
	// Required: true
	Risk *APISecurityRiskSeverity `json:"risk"`

	// Scorer Version
	// Required: true
	ScorerVersion *int64 `json:"scorer_version"`

	// trend
	Trend RiskTrendEnum `json:"trend,omitempty"`
}

type APIOrConditionsBase interface {
	runtime.Validatable
	runtime.ContextValidatable

	// attribute
	// Required: true
	// Enum: [ApiRisk ApiRiskTrend ApiRiskTrendIsNone ApiRiskConfidence ApiRiskConfidenceIsNone ApiAvgVulnerabilityDuration ApiAvgVulnerabilityDurationIsNone ApiName ApiClassification ApiClassificationIsNone]
	Attribute() string
	SetAttribute(string)
}

type APIPolicyProfile struct {

	// Compliant On Missing Score
	// Required: true
	CompliantOnMissingScore *bool `json:"compliant_on_missing_score"`

	// Conditions
	//
	// List conditions defined in this policy profile. All conditions are in AND.
	// Required: true
	Conditions []*APIPolicyProfileCondition `json:"conditions"`

	// Name
	//
	// Name of the policy profile
	// Required: true
	Name *string `json:"name"`
}

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

type APIProviderBase struct {

	// id
	//
	// Unique id of the subject API as assigned by Crankshaft
	// Required: true
	// Format: uuid
	Identifier *strfmt.UUID `json:"identifier"`

	// Industry
	Industry string `json:"industry,omitempty"`

	// Location
	Location string `json:"location,omitempty"`

	// Name
	//
	// Name of the provider, typically an FQDN
	// Required: true
	Name *string `json:"name"`
}

type APIProviderScoreGrade struct {

	// Additional Info
	AdditionalInfo []*AdditionalInfo `json:"additional_info"`

	// Avg Vulnerability Duration
	AvgVulnerabilityDuration int64 `json:"avg_vulnerability_duration,omitempty"`

	// Categories
	// Required: true
	Categories map[string]CategoryScoreGradeNoFindings `json:"categories"`

	// confidence
	Confidence RiskConfidenceEnum `json:"confidence,omitempty"`

	// Curated
	// Required: true
	Curated *bool `json:"curated"`

	// Last Finding Date
	// Format: date-time
	LastFindingDate strfmt.DateTime `json:"last_finding_date,omitempty"`

	// Last Vulnerability Date
	// Format: date-time
	LastVulnerabilityDate strfmt.DateTime `json:"last_vulnerability_date,omitempty"`

	// provider
	// Required: true
	Provider *APIProviderBase `json:"provider"`

	// provider id
	// Format: uuid
	ProviderID strfmt.UUID `json:"provider_id,omitempty"`

	// risk
	// Required: true
	Risk *APISecurityRiskSeverity `json:"risk"`

	// Scorer Version
	// Required: true
	ScorerVersion *int64 `json:"scorer_version"`

	// trend
	Trend RiskTrendEnum `json:"trend,omitempty"`
}

type APISecurityAPI struct {

	// API name, usually an FQDN as determined by crankshaft, it can be logical or can correspond to one of the endpoints where the API is reachable, i.e. api.webex.com
	// Required: true
	Name *string `json:"name"`
}

type APISecurityAPIStatus string

type APISecurityRiskSeverity string

type APIServiceBase struct {

	// Classification
	//
	// API classification label as determined by Crankshaft, e.g. ['meetings', 'messaging']
	Classification []string `json:"classification"`

	// Timestamp
	// Format: date-time
	CreationTimestamp strfmt.DateTime `json:"creation_timestamp,omitempty"`

	// Description
	//
	// Textual description of the Service
	Description string `json:"description,omitempty"`

	// id
	//
	// Unique id of the subject API as assigned by Crankshaft
	// Required: true
	// Format: uuid
	Identifier *strfmt.UUID `json:"identifier"`

	// Name
	//
	// API name, usually an FQDN as determined by crankshaft, it can be logical or can correspond to one of the endpoints where the API is reachable, i.e. api.webex.com
	// Required: true
	Name *string `json:"name"`

	// Provider Id
	//
	// API provider id
	// Format: uuid
	ProviderID strfmt.UUID `json:"provider_id,omitempty"`

	// risk
	Risk APISecurityRiskSeverity `json:"risk,omitempty"`

	// status
	Status APISecurityAPIStatus `json:"status,omitempty"`

	// status description
	StatusDescription string `json:"status_description,omitempty"`
}

type APIServiceClientWorkload struct {

	// cluster
	Cluster string `json:"cluster,omitempty"`

	// namespace
	Namespace string `json:"namespace,omitempty"`

	// workload name
	WorkloadName string `json:"workloadName,omitempty"`
}

type APIServiceCompliance struct {

	// Compliant
	// Required: true
	Compliant *bool `json:"compliant"`

	// Profilescompliance
	// Required: true
	Profilescompliance []*APIServiceProfileCompliance `json:"profilescompliance"`
}

type APIServiceComplianceSimple struct {

	// Compliant
	// Required: true
	Compliant *bool `json:"compliant"`

	// Profilescompliance
	// Required: true
	Profilescompliance []*APIServiceProfileComplianceSimple `json:"profilescompliance"`
}

type APIServiceDrillDownBase struct {

	// client workloads
	ClientWorkloads []*APIServiceClientWorkload `json:"clientWorkloads"`

	// compliance
	Compliance *APIServiceCompliance `json:"compliance,omitempty"`

	// Timestamp
	// Format: date-time
	CreationTimestamp strfmt.DateTime `json:"creation_timestamp,omitempty"`

	// Description
	//
	// Textual description of the Service
	Description string `json:"description,omitempty"`

	// Identifier
	//
	// Unique identifier of the subject API as assigned by Crankshaft
	// Required: true
	// Format: uuid
	Identifier *strfmt.UUID `json:"identifier"`

	// Link Doc
	//
	// Location of the documentation. This can be an URL for example
	LinkDoc string `json:"link_doc,omitempty"`

	// Name
	//
	// API name, usually an FQDN as determined by crankshaft, it can be logical or can correspond to one of the endpoints where the API is reachable, i.e. api.webex.com
	// Required: true
	Name *string `json:"name"`

	// risk
	Risk APISecurityRiskSeverity `json:"risk,omitempty"`

	// score
	Score *APIServiceScore `json:"score,omitempty"`

	// status
	Status APISecurityAPIStatus `json:"status,omitempty"`

	// status description
	StatusDescription string `json:"status_description,omitempty"`
}

type APIServiceDrillDownExternal struct {
	APIServiceDrillDownBase

	// Classification
	//
	// API classification label as determined by Crankshaft, e.g. ['meetings', 'messaging']
	Classification []string `json:"classification"`

	// provider
	Provider *APIProviderBase `json:"provider,omitempty"`
}

type APIServiceExternal struct {
	APIServiceBase

	// Classification
	//
	// API classification label as determined by Crankshaft, e.g. ['meetings', 'messaging']
	Classification []string `json:"classification"`

	// Provider Id
	//
	// API provider id
	// Format: uuid
	ProviderID strfmt.UUID `json:"provider_id,omitempty"`

	// Provider Name
	//
	// Provider name if provider_id is set.
	ProviderName string `json:"provider_name,omitempty"`
}

type APIServiceListExternal struct {

	// Items
	// Required: true
	Items []*APIServiceExternal `json:"items"`
}

type APIServiceProfileCompliance struct {

	// Api Id
	//
	// Api Service this compliance refers to
	// Required: true
	// Format: uuid
	APIID *strfmt.UUID `json:"api_id"`

	// Compliant
	//
	// True if score is compliant with the profile. False otherwise.
	// Required: true
	Compliant *bool `json:"compliant"`

	// profile
	// Required: true
	Profile *APIPolicyProfile `json:"profile"`

	// Score Id
	//
	// If existing, score used to compute the compliance
	// Format: uuid
	ScoreID strfmt.UUID `json:"score_id,omitempty"`

	// violation
	Violation *ProfileViolation `json:"violation,omitempty"`
}

type APIServiceProfileComplianceSimple struct {

	// Compliant
	// Required: true
	Compliant *bool `json:"compliant"`

	// Profile
	// Required: true
	Profile *string `json:"profile"`
}

type APIServiceScore struct {

	// api
	// Required: true
	API *APIServiceScoreGrade `json:"api"`

	// id
	// Required: true
	// Format: uuid
	Identifier *strfmt.UUID `json:"identifier"`

	// provider
	// Required: true
	Provider *APIProviderScoreGrade `json:"provider"`

	// status
	// Required: true
	Status *ScoreExitStatusEnum `json:"status"`

	// Timestamp
	// Required: true
	// Format: date-time
	Timestamp *strfmt.DateTime `json:"timestamp"`
}

type APIServiceScoreGrade struct {

	// Additional Info
	AdditionalInfo []*AdditionalInfo `json:"additional_info"`

	// api
	// Required: true
	API *APIServiceBase `json:"api"`

	// Avg Vulnerability Duration
	AvgVulnerabilityDuration int64 `json:"avg_vulnerability_duration,omitempty"`

	// Categories
	// Required: true
	Categories map[string]CategoryScoreGrade `json:"categories"`

	// confidence
	Confidence RiskConfidenceEnum `json:"confidence,omitempty"`

	// counters history
	CountersHistory *CountersHistory `json:"counters_history,omitempty"`

	// Endpoints
	// Required: true
	Endpoints []*APIEndpointScoreGrade `json:"endpoints"`

	// Last Finding Date
	// Format: date-time
	LastFindingDate strfmt.DateTime `json:"last_finding_date,omitempty"`

	// Last Vulnerability Date
	// Format: date-time
	LastVulnerabilityDate strfmt.DateTime `json:"last_vulnerability_date,omitempty"`

	// risk
	// Required: true
	Risk *APISecurityRiskSeverity `json:"risk"`

	// Scorer Version
	// Required: true
	ScorerVersion *int64 `json:"scorer_version"`

	// trend
	Trend RiskTrendEnum `json:"trend,omitempty"`
}

type AdditionalInfo struct {

	// Affected Endpoints
	AffectedEndpoints []string `json:"affected_endpoints"`

	// Affected Spec Paths
	AffectedSpecPaths []string `json:"affected_spec_paths"`

	// Dictionary entries
	Entries map[string]string `json:"entries,omitempty"`
}

type CategoryScoreGrade struct {

	// Additional Info
	AdditionalInfo []*AdditionalInfo `json:"additional_info"`

	// confidence
	Confidence RiskConfidenceEnum `json:"confidence,omitempty"`

	// counters history
	CountersHistory *CountersHistory `json:"counters_history,omitempty"`

	// critical
	// Required: true
	Critical *ScoreFindingGroup `json:"critical"`

	// high
	// Required: true
	High *ScoreFindingGroup `json:"high"`

	// low
	// Required: true
	Low *ScoreFindingGroup `json:"low"`

	// medium
	// Required: true
	Medium *ScoreFindingGroup `json:"medium"`

	// Name
	// Required: true
	Name *string `json:"name"`

	// risk
	// Required: true
	Risk *APISecurityRiskSeverity `json:"risk"`

	// Scorer Version
	// Required: true
	ScorerVersion *int64 `json:"scorer_version"`

	// trend
	Trend RiskTrendEnum `json:"trend,omitempty"`

	// unclassified
	// Required: true
	Unclassified *ScoreFindingGroup `json:"unclassified"`
}

type CategoryScoreGradeNoFindings struct {

	// Additional Info
	AdditionalInfo []*AdditionalInfo `json:"additional_info"`

	// confidence
	Confidence RiskConfidenceEnum `json:"confidence,omitempty"`

	// Critical
	// Required: true
	Critical *int64 `json:"critical"`

	// High
	// Required: true
	High *int64 `json:"high"`

	// Low
	// Required: true
	Low *int64 `json:"low"`

	// Medium
	// Required: true
	Medium *int64 `json:"medium"`

	// Name
	// Required: true
	Name *string `json:"name"`

	// risk
	// Required: true
	Risk *APISecurityRiskSeverity `json:"risk"`

	// Scorer Version
	// Required: true
	ScorerVersion *int64 `json:"scorer_version"`

	// trend
	Trend RiskTrendEnum `json:"trend,omitempty"`

	// Unclassified
	// Required: true
	Unclassified *int64 `json:"unclassified"`
}

type CountersHistory struct {

	// Critical
	Critical []int64 `json:"critical"`

	// High
	High []int64 `json:"high"`

	// Low
	Low []int64 `json:"low"`

	// Medium
	Medium []int64 `json:"medium"`

	// Timestamp
	Timestamp []string `json:"timestamp"`

	// Unclassified
	Unclassified []int64 `json:"unclassified"`
}

type EndpointOrConditionsBase interface {
	runtime.Validatable
	runtime.ContextValidatable

	// attribute
	// Required: true
	// Enum: [EndpointRisk EndpointRiskTrend EndpointRiskTrendIsNone EndpointRiskConfidence EndpointRiskConfidenceIsNone EndpointLocation EndpointLocationIsNone EndpointHostV4 EndpointHostV6 EndpointHostname EndpointHostnameIsNone EndpointScheme EndpointSchemeIsNone EndpointProtocol EndpointPort]
	Attribute() string
	SetAttribute(string)
}

type HTTPMethod string

type IPProtoEnum string

type OAPIV3Components struct {

	// elements
	Elements []*OpenAPISpecScoreComponentsV3ElementsList `json:"elements"`

	// severity
	Severity APISecurityRiskSeverity `json:"severity,omitempty"`
}

type OpenAPISpec struct {

	// preview
	Preview *OpenAPISpecPreview `json:"preview,omitempty"`
	// contains filtered or unexported fields
}

type OpenAPISpecPreview struct {

	// base path
	BasePath string `json:"basePath,omitempty"`

	// contact mail
	ContactMail string `json:"contactMail,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// license name
	LicenseName string `json:"licenseName,omitempty"`

	// license Url
	LicenseURL string `json:"licenseUrl,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// terms of service
	TermsOfService string `json:"termsOfService,omitempty"`

	// version
	Version string `json:"version,omitempty"`
}

type OpenAPISpecScoreBase interface {
	runtime.Validatable
	runtime.ContextValidatable

	// general
	General() *OpenAPISpecScoreElementsList
	SetGeneral(*OpenAPISpecScoreElementsList)

	// oap i version
	// Enum: [OpenApiSpecScoreV2 OpenApiSpecScoreV3]
	OapIVersion() string
	SetOapIVersion(string)

	// security
	Security() *OpenAPISpecScoreElementsList
	SetSecurity(*OpenAPISpecScoreElementsList)

	// tags
	Tags() *OpenAPISpecTags
	SetTags(*OpenAPISpecTags)
}

type OpenAPISpecScoreComponentsV3ElementsList struct {
	OpenAPISpecScoreElementsList

	// Name
	Name string `json:"name,omitempty"`
}

type OpenAPISpecScoreElement struct {

	// findings
	Findings *SpecScoreFindings `json:"findings,omitempty"`

	// Name
	//
	// Name of the Object
	Name string `json:"name,omitempty"`

	// severity
	Severity APISecurityRiskSeverity `json:"severity,omitempty"`

	// spec path
	SpecPath string `json:"specPath,omitempty"`
}

type OpenAPISpecScoreElementsList struct {

	// elements
	Elements []*OpenAPISpecScoreElement `json:"elements"`

	// severity
	Severity APISecurityRiskSeverity `json:"severity,omitempty"`
}

type OpenAPISpecScoreStatus string

type OpenAPISpecScoreV2 struct {

	// definitions
	Definitions *OpenAPISpecScoreElementsList `json:"definitions,omitempty"`

	// parameters
	Parameters *OpenAPISpecScoreElementsList `json:"parameters,omitempty"`

	// responses
	Responses *OpenAPISpecScoreElementsList `json:"responses,omitempty"`

	// security definitions
	SecurityDefinitions *OpenAPISpecScoreElementsList `json:"securityDefinitions,omitempty"`
	// contains filtered or unexported fields
}

type OpenAPISpecScoreV3 struct {

	// components
	Components *OAPIV3Components `json:"components,omitempty"`

	// servers
	Servers *OpenAPISpecScoreElementsList `json:"servers,omitempty"`
	// contains filtered or unexported fields
}

type OpenAPISpecTag struct {

	// methods
	Methods []*SpecMethod `json:"methods"`

	// name
	Name string `json:"name,omitempty"`

	// severity
	Severity APISecurityRiskSeverity `json:"severity,omitempty"`
}

type OpenAPISpecTags struct {

	// elements
	Elements []*OpenAPISpecTag `json:"elements"`

	// severity
	Severity APISecurityRiskSeverity `json:"severity,omitempty"`
}

type ProfileViolation struct {

	// Condition Index
	//
	// Index of the condition violated in the API Policy Profile
	// Required: true
	ConditionIndex *int64 `json:"condition_index"`

	// Description
	//
	// Human readable description of the violation
	// Required: true
	Description *string `json:"description"`
}

type ProviderOrConditionsBase interface {
	runtime.Validatable
	runtime.ContextValidatable

	// attribute
	// Required: true
	// Enum: [ProviderRisk ProviderRiskTrend ProviderRiskTrendIsNone ProviderRiskConfidence ProviderRiskConfidenceIsNone ProviderAvgVulnerabilityDuration ProviderAvgVulnerabilityDurationIsNone ProviderName ProviderLocation ProviderLocationIsNone ProviderIndustry ProviderIndustryIsNone]
	Attribute() string
	SetAttribute(string)
}

type RiskConfidenceEnum string

type RiskTrendEnum string

type ScoreExitStatusEnum string

type ScoreFinding struct {

	// Additional Info
	//
	// Finding instance additional attributes
	AdditionalInfo []*AdditionalInfo `json:"additional_info"`

	// Data
	//
	// Raw data filled in only for unclassified findings, when allowed
	Data interface{} `json:"data,omitempty"`

	// Description
	//
	// Finding description if finding has been classified, None otherwise
	Description string `json:"description,omitempty"`

	// Mitigation
	//
	// Finding mitigation if finding has been classified, None otherwise
	Mitigation string `json:"mitigation,omitempty"`

	// Name
	//
	// Finding name
	// Required: true
	Name *string `json:"name"`

	// Occurrences
	//
	// Number of findings of the same type
	Occurrences int64 `json:"occurrences,omitempty"`

	// Raw Finding Id
	//
	// Identifier of the raw finding if available
	// Format: uuid
	RawFindingID strfmt.UUID `json:"raw_finding_id,omitempty"`

	// Source
	//
	// Finding source or filled in with 'Undisclosed' if source cannot be revealed
	// Required: true
	Source *string `json:"source"`

	// Type Id
	//
	// Finding type identifier if finding has been classified, None otherwise
	// Format: uuid
	TypeID strfmt.UUID `json:"type_id,omitempty"`
}

type ScoreFindingGroup struct {

	// Count
	// Required: true
	Count *int64 `json:"count"`

	// Findings
	// Required: true
	Findings []*ScoreFinding `json:"findings"`
}

type SpecMethod struct {

	// description
	Description string `json:"description,omitempty"`

	// findings
	Findings *SpecScoreFindings `json:"findings,omitempty"`

	// method
	Method HTTPMethod `json:"method,omitempty"`

	// path
	Path string `json:"path,omitempty"`

	// severity
	Severity APISecurityRiskSeverity `json:"severity,omitempty"`

	// tag
	Tag string `json:"tag,omitempty"`
}

type SpecScoreElementFinding struct {

	// description
	Description string `json:"description,omitempty"`

	// mitigation
	Mitigation string `json:"mitigation,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// spec path
	SpecPath string `json:"specPath,omitempty"`
}

type SpecScoreFindings struct {

	// critical
	Critical *SpecScoreFindingsList `json:"critical,omitempty"`

	// high
	High *SpecScoreFindingsList `json:"high,omitempty"`

	// low
	Low *SpecScoreFindingsList `json:"low,omitempty"`

	// medium
	Medium *SpecScoreFindingsList `json:"medium,omitempty"`

	// unclassified
	Unclassified *SpecScoreFindingsList `json:"unclassified,omitempty"`
}

type SpecScoreFindingsList struct {

	// count
	Count int64 `json:"count,omitempty"`

	// elements
	Elements []*SpecScoreElementFinding `json:"elements"`
}

type URLSchemeEnum string

type VulnerabilitiesSummary struct {

	// critical
	// Minimum: 0
	Critical *int64 `json:"critical,omitempty"`

	// high
	// Minimum: 0
	High *int64 `json:"high,omitempty"`

	// low
	// Minimum: 0
	Low *int64 `json:"low,omitempty"`

	// medium
	// Minimum: 0
	Medium *int64 `json:"medium,omitempty"`

	// total
	// Minimum: 0
	Total *int64 `json:"total,omitempty"`

	// unknown
	// Minimum: 0
	Unknown *int64 `json:"unknown,omitempty"`
}