apigen

type BatchRatingRequest struct {
	Identifiers []TargetIdentifier `json:"identifiers"`

	// Timeout Max wait time for any individual scan
	Timeout *int32 `json:"timeout,omitempty"`
}

type BatchRatingResponse struct {
	// Ratings Per-item rating link results for the requested identifiers.
	Ratings []struct {
		Identifier TargetIdentifier `json:"identifier"`

		// RatingUrl URL path to fetch full rating details for this item.
		RatingUrl string `json:"rating_url"`
	} `json:"ratings"`
}

type DefaultError = Error

type Error struct {
	// Details Additional error context
	Details *map[string]interface{} `json:"details,omitempty"`

	// Error Error code
	Error string `json:"error"`

	// Message Human-readable error message
	Message string `json:"message"`

	// RequestId Unique request identifier for debugging
	RequestId *string `json:"request_id,omitempty"`
}

type ErrorResponse struct {
	Details *map[string]interface{} `json:"details,omitempty"`
	Error   string                  `json:"error"`
	Message string                  `json:"message"`
}

type GetHealthParams struct {
	// Authorization Bearer publishable key (format: ^ens_pk_live_[a-f0-9]{40}$)
	Authorization PublishableAuthHeader `json:"Authorization"`
}

type GetRatingByOCIParams struct {
	// Timeout Maximum time to wait for scan completion (seconds)
	Timeout *TimeoutQuery `form:"timeout,omitempty" json:"timeout,omitempty"`

	// XOrgUuid Optional organization UUID for usage reporting
	XOrgUuid *OrgUuidHeader `json:"X-Org-Uuid,omitempty"`

	// XHostUuid Optional host UUID for usage reporting
	XHostUuid *HostUuidHeader `json:"X-Host-Uuid,omitempty"`

	// Authorization Bearer publishable key (format: ^ens_pk_live_[a-f0-9]{40}$)
	Authorization PublishableAuthHeader `json:"Authorization"`
}

type GetRatingByPurlParams struct {
	// Timeout Maximum time to wait for scan completion (seconds)
	Timeout *TimeoutQuery `form:"timeout,omitempty" json:"timeout,omitempty"`

	// XOrgUuid Optional organization UUID for usage reporting
	XOrgUuid *OrgUuidHeader `json:"X-Org-Uuid,omitempty"`

	// XHostUuid Optional host UUID for usage reporting
	XHostUuid *HostUuidHeader `json:"X-Host-Uuid,omitempty"`

	// Authorization Bearer publishable key (format: ^ens_pk_live_[a-f0-9]{40}$)
	Authorization PublishableAuthHeader `json:"Authorization"`
}

type GetRatingByRepoParams struct {
	// Timeout Maximum time to wait for scan completion (seconds)
	Timeout *TimeoutQuery `form:"timeout,omitempty" json:"timeout,omitempty"`

	// XOrgUuid Optional organization UUID for usage reporting
	XOrgUuid *OrgUuidHeader `json:"X-Org-Uuid,omitempty"`

	// XHostUuid Optional host UUID for usage reporting
	XHostUuid *HostUuidHeader `json:"X-Host-Uuid,omitempty"`

	// Authorization Bearer publishable key (format: ^ens_pk_live_[a-f0-9]{40}$)
	Authorization PublishableAuthHeader `json:"Authorization"`
}

type GetRatingByUrlParams struct {
	// Timeout Maximum time to wait for scan completion (seconds)
	Timeout *TimeoutQuery `form:"timeout,omitempty" json:"timeout,omitempty"`

	// XOrgUuid Optional organization UUID for usage reporting
	XOrgUuid *OrgUuidHeader `json:"X-Org-Uuid,omitempty"`

	// XHostUuid Optional host UUID for usage reporting
	XHostUuid *HostUuidHeader `json:"X-Host-Uuid,omitempty"`

	// Authorization Bearer publishable key (format: ^ens_pk_live_[a-f0-9]{40}$)
	Authorization PublishableAuthHeader `json:"Authorization"`
}

type GetRatingsBatchJSONRequestBody = BatchRatingRequest

type GetRatingsBatchParams struct {
	// Timeout Maximum time to wait for scan completion (seconds)
	Timeout *TimeoutQuery `form:"timeout,omitempty" json:"timeout,omitempty"`

	// XOrgUuid Optional organization UUID for usage reporting
	XOrgUuid *OrgUuidHeader `json:"X-Org-Uuid,omitempty"`

	// XHostUuid Optional host UUID for usage reporting
	XHostUuid *HostUuidHeader `json:"X-Host-Uuid,omitempty"`

	// Authorization Bearer publishable key (format: ^ens_pk_live_[a-f0-9]{40}$)
	Authorization PublishableAuthHeader `json:"Authorization"`
}

type GetScanStatusParams struct {
	// XOrgUuid Optional organization UUID for usage reporting
	XOrgUuid *OrgUuidHeader `json:"X-Org-Uuid,omitempty"`

	// XHostUuid Optional host UUID for usage reporting
	XHostUuid *HostUuidHeader `json:"X-Host-Uuid,omitempty"`

	// Authorization Bearer publishable key (format: ^ens_pk_live_[a-f0-9]{40}$)
	Authorization PublishableAuthHeader `json:"Authorization"`
}

type HealthResponse struct {
	// ApiSpecVersion Duplicate of API spec version for explicitness.
	ApiSpecVersion string `json:"api_spec_version"`
	Capabilities   struct {
		AsyncScanning   *bool `json:"async_scanning,omitempty"`
		BatchOperations *bool `json:"batch_operations,omitempty"`
		RatingsLookup   *bool `json:"ratings_lookup,omitempty"`
	} `json:"capabilities"`

	// Errors Critical issues (when status is unhealthy)
	Errors *[]string `json:"errors,omitempty"`

	// ServerVersion Deployed server implementation version.
	ServerVersion string `json:"server_version"`
	Services      struct {
		Database     *HealthResponseServicesDatabase     `json:"database,omitempty"`
		ScannerQueue *HealthResponseServicesScannerQueue `json:"scanner_queue,omitempty"`
	} `json:"services"`

	// Status Overall service health status
	Status HealthResponseStatus `json:"status"`

	// Timestamp Health check timestamp
	Timestamp time.Time `json:"timestamp"`

	// Version API spec version.
	Version string `json:"version"`

	// Warnings Non-critical issues
	Warnings *[]string `json:"warnings,omitempty"`
}

type HealthResponseServicesDatabase string

type HealthResponseServicesScannerQueue string

type HealthResponseStatus string

type HostUuidHeader = openapi_types.UUID

type IdentifierKind string

type NotAcceptable = Error

type OrgUuidHeader = openapi_types.UUID

type PublishableAuthHeader = string

type RateLimited = Error

type RatingNotAvailableOrNotFound = Error

type RatingResponse struct {
	// Links Optional navigation links related to this batch request.
	Links *struct {
		// Ratings Per-item rating links for convenience.
		Ratings *[]struct {
			// Name Optional human-friendly name for the rated item.
			Name *string `json:"name,omitempty"`

			// RatingUrl URL path to fetch full rating details for this item.
			RatingUrl string `json:"rating_url"`
		} `json:"ratings,omitempty"`

		// ScanStatus URL to the scan-status resource tracking any pending work for this batch.
		ScanStatus *string `json:"scan_status,omitempty"`
	} `json:"links,omitempty"`

	// Ratings Successfully retrieved ratings
	Ratings []SecurityRating `json:"ratings"`
}

type ScanExpired = Error

type ScanInProgress struct {
	// EstimatedCompletion Estimated completion time
	EstimatedCompletion time.Time `json:"estimated_completion"`

	// PollUrl URL path to poll for updates
	PollUrl *string `json:"poll_url,omitempty"`

	// ScanId Unique scan identifier for polling
	ScanId openapi_types.UUID `json:"scan_id"`

	// Status Current scan status
	Status ScanInProgressStatus `json:"status"`
}

type ScanInProgressStatus string

type ScanMetrics struct {
	ScanDurationMs   *int64 `json:"scan_duration_ms"`
	TargetsCompleted *int32 `json:"targets_completed,omitempty"`
	TargetsFailed    *int32 `json:"targets_failed,omitempty"`
	TargetsTotal     *int32 `json:"targets_total,omitempty"`
}

type ScanNotFound = Error

type ScanStatus struct {
	CompletedAt  *time.Time `json:"completed_at"`
	ErrorMessage *string    `json:"error_message"`
	Links        *struct {
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Metrics *ScanMetrics `json:"metrics,omitempty"`

	// Progress Aggregate completion percentage across targets.
	Progress  *int32             `json:"progress,omitempty"`
	ScanId    openapi_types.UUID `json:"scan_id"`
	StartedAt time.Time          `json:"started_at"`

	// Status Aggregate status across all targets.
	Status    ScanStatusStatus `json:"status"`
	Targets   []ScanTarget     `json:"targets"`
	UpdatedAt *time.Time       `json:"updated_at"`
}

type ScanStatusStatus string

type ScanTarget struct {
	CompletedAt  *time.Time       `json:"completed_at"`
	ErrorMessage *string          `json:"error_message"`
	Identifier   TargetIdentifier `json:"identifier"`

	// Name Human-friendly target label (e.g., package or server name).
	Name string `json:"name"`

	// RatingUrl URL path to fetch full rating details for this target when status is completed.
	RatingUrl *string          `json:"rating_url"`
	StartedAt *time.Time       `json:"started_at"`
	Status    ScanTargetStatus `json:"status"`
}

type ScanTargetStatus string

type SecurityRating struct {
	// Classification Security classification for the server.
	Classification SecurityRatingClassification `json:"classification"`

	// Description Human-readable summary of what the server provides and how it integrates.
	Description string `json:"description"`

	// Identifiers Consolidated identifiers discovered for this server.
	Identifiers *struct {
		// Oci OCI image reference if known.
		Oci *string `json:"oci,omitempty"`

		// Purl Package URL if known.
		Purl *string `json:"purl,omitempty"`

		// Repo GitHub/GitLab repository if known (org/repo or full URL).
		Repo *string `json:"repo,omitempty"`

		// ServerUrl MCP server base URL if known.
		ServerUrl *string `json:"server_url,omitempty"`
	} `json:"identifiers,omitempty"`

	// Labels Tags describing capabilities or domains (e.g., CI/CD, Development, Code Scanning, Package Management).
	Labels *[]string `json:"labels,omitempty"`

	// LastUpdated When this rating was last updated.
	LastUpdated time.Time `json:"last_updated"`

	// License Detected software license identifier (e.g., MIT, Apache-2.0).
	License *SecurityRatingLicense `json:"license,omitempty"`

	// Name MCP server name.
	Name string `json:"name"`

	// Permissions Capability-related security permissions.
	Permissions *struct {
		// FilesystemRead Server or tools can read the filesystem.
		FilesystemRead *bool `json:"filesystem_read,omitempty"`

		// FilesystemWrite Server or tools can write to the filesystem.
		FilesystemWrite *bool `json:"filesystem_write,omitempty"`

		// NetworkAccess Server or tools can access the network.
		NetworkAccess *bool `json:"network_access,omitempty"`
	} `json:"permissions,omitempty"`

	// ScanDetails Additional scan metadata.
	ScanDetails *struct {
		ScanDurationMs      *int64   `json:"scan_duration_ms,omitempty"`
		ScannedFiles        *int32   `json:"scanned_files,omitempty"`
		StaticAnalysisScore *float32 `json:"static_analysis_score,omitempty"`
	} `json:"scan_details,omitempty"`
	Scores struct {
		// Components Score breakdown by signal area.
		Components struct {
			CodeQuality     *int32 `json:"code_quality,omitempty"`
			Maintenance     *int32 `json:"maintenance,omitempty"`
			SupplyChain     *int32 `json:"supply_chain,omitempty"`
			Vulnerabilities *int32 `json:"vulnerabilities,omitempty"`
		} `json:"components"`

		// Confidence Confidence level in the computed scores.
		Confidence *SecurityRatingScoresConfidence `json:"confidence,omitempty"`

		// OverallGrade Letter grade summarizing security posture.
		OverallGrade SecurityRatingScoresOverallGrade `json:"overall_grade"`

		// OverallPercent Overall score as a percentage.
		OverallPercent *int32 `json:"overall_percent,omitempty"`
	} `json:"scores"`

	// Source How this rating was determined.
	Source SecurityRatingSource `json:"source"`

	// ToolCalls Catalog of available tool calls.
	ToolCalls *[]struct {
		// Category Action category (e.g., Create, Read, Update, Delete). Optional.
		Category *string `json:"category,omitempty"`

		// Description Human-readable tool description.
		Description *string `json:"description,omitempty"`

		// Name Tool call name.
		Name *string `json:"name,omitempty"`

		// Sensitive Whether the tool is considered sensitive.
		Sensitive *bool `json:"sensitive,omitempty"`
	} `json:"tool_calls,omitempty"`

	// ToolCallsCount Number of available tool calls reported by the server.
	ToolCallsCount *int32 `json:"tool_calls_count,omitempty"`

	// Version Server version.
	Version *string `json:"version,omitempty"`

	// Vulnerabilities Known CVEs or security issues.
	Vulnerabilities *[]string `json:"vulnerabilities,omitempty"`
}

type SecurityRatingClassification string

type SecurityRatingLicense string

type SecurityRatingScoresConfidence string

type SecurityRatingScoresOverallGrade string

type SecurityRatingSource string

type ServiceUnavailable = Error

type TargetIdentifier struct {
	// Kind Type of identifier.
	Kind  IdentifierKind `json:"kind"`
	Value string         `json:"value"`
}

type TimeoutQuery = int32

type Unauthorized = Error

type UnsupportedMediaType = Error