models

type APIClarityFeature struct {

	// Short human readable description of the feature
	FeatureDescription string `json:"featureDescription,omitempty"`

	// feature name
	// Required: true
	FeatureName *APIClarityFeatureEnum `json:"featureName"`

	// hosts to trace
	HostsToTrace *HostsToTraceForComponent `json:"hostsToTrace,omitempty"`
}

type APIClarityFeatureEnum string

type APIClarityFeatureList struct {

	// features
	Features []*APIClarityFeature `json:"features"`
}

type APICount struct {

	// api host name
	APIHostName string `json:"apiHostName,omitempty"`

	// hold the relevant api info id
	APIInfoID uint32 `json:"apiInfoId,omitempty"`

	// api port
	APIPort int64 `json:"apiPort,omitempty"`

	// api type
	APIType APIType `json:"apiType,omitempty"`

	// num calls
	NumCalls int64 `json:"numCalls,omitempty"`
}

type APIEvent struct {

	// alerts
	Alerts []*ModuleAlert `json:"alerts"`

	// hold the relevant api spec info id
	APIInfoID uint32 `json:"apiInfoId,omitempty"`

	// api type
	APIType APIType `json:"apiType,omitempty"`

	// destination IP
	DestinationIP string `json:"destinationIP,omitempty"`

	// destination port
	DestinationPort int64 `json:"destinationPort,omitempty"`

	// has provided spec diff
	HasProvidedSpecDiff *bool `json:"hasProvidedSpecDiff,omitempty"`

	// has reconstructed spec diff
	HasReconstructedSpecDiff *bool `json:"hasReconstructedSpecDiff,omitempty"`

	// host spec name
	HostSpecName string `json:"hostSpecName,omitempty"`

	// id
	ID uint32 `json:"id,omitempty"`

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

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

	// query
	Query string `json:"query,omitempty"`

	// request time
	// Format: date-time
	RequestTime strfmt.DateTime `json:"requestTime,omitempty"`

	// source IP
	SourceIP string `json:"sourceIP,omitempty"`

	// spec diff type
	SpecDiffType *DiffType `json:"specDiffType,omitempty"`

	// status code
	StatusCode int64 `json:"statusCode,omitempty"`

	// time
	// Format: date-time
	Time strfmt.DateTime `json:"time,omitempty"`
}

type APIEventPathAndMethods struct {

	// methods
	Methods []HTTPMethod `json:"methods"`

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

type APIEventSortKey string

type APIEventSpecDiff struct {

	// diff type
	DiffType *DiffType `json:"diffType,omitempty"`

	// New spec json string
	// Required: true
	NewSpec *string `json:"newSpec"`

	// Old spec json string
	// Required: true
	OldSpec *string `json:"oldSpec"`
}

type APIInfo struct {

	// destination namespace
	DestinationNamespace string `json:"destinationNamespace,omitempty"`

	// has provided spec
	HasProvidedSpec *bool `json:"hasProvidedSpec,omitempty"`

	// has reconstructed spec
	HasReconstructedSpec *bool `json:"hasReconstructedSpec,omitempty"`

	// id
	ID uint32 `json:"id,omitempty"`

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

	// port
	Port int64 `json:"port,omitempty"`

	// Trace Source ID which created this API. Null UUID 0 means it has been created by APIClarity (from the UI for example)
	// Format: uuid
	TraceSourceID strfmt.UUID `json:"traceSourceId,omitempty"`
}

type APIInfoWithType struct {
	APIInfo

	// api type
	APIType APIType `json:"apiType,omitempty"`
}

type APIInventorySortKey string

type APIResponse struct {

	// message
	Message string `json:"message,omitempty"`
}

type APIType string

type APIUsage struct {

	// num of calls
	NumOfCalls int64 `json:"numOfCalls"`

	// time
	// Format: date-time
	Time strfmt.DateTime `json:"time,omitempty"`
}

type APIUsages struct {

	// apis with diff
	ApisWithDiff []*APIUsage `json:"apisWithDiff"`

	// existing apis
	ExistingApis []*APIUsage `json:"existingApis"`

	// new apis
	NewApis []*APIUsage `json:"newApis"`
}

type AlertSeverityEnum string

type ApprovedReview struct {

	// OpenAPI specification version to use when saving the approved spec
	// Enum: [OASv2.0 OASv3.0]
	OasVersion string `json:"oasVersion,omitempty"`

	// review path items
	ReviewPathItems []*ReviewPathItem `json:"reviewPathItems"`
}

type DiffType string

type HTTPMethod string

type HitCount struct {

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

	// time
	// Format: date-time
	Time strfmt.DateTime `json:"time,omitempty"`
}

type HostsToTraceForComponent struct {

	// Component name
	Component string `json:"component,omitempty"`

	// trace sources hosts
	TraceSourcesHosts []*HostsToTraceForTraceSource `json:"traceSourcesHosts"`
}

type HostsToTraceForTraceSource struct {

	// List of hosts (in the form 'host:port')
	HostsToTrace []string `json:"hostsToTrace"`

	// ID of the trace source
	TraceSourceID uint32 `json:"traceSourceID,omitempty"`
}

type MethodAndPath struct {

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

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

	// path Id
	// Format: uuid
	PathID strfmt.UUID `json:"pathId,omitempty"`
}

type ModuleAlert struct {

	// alert
	Alert AlertSeverityEnum `json:"alert,omitempty"`

	// Name of the module which created this alert
	ModuleName string `json:"moduleName,omitempty"`

	// Optional description of reason of the alert
	Reason string `json:"reason,omitempty"`
}

type OASVersion string

type OpenAPISpecs struct {

	// provided spec
	ProvidedSpec *SpecInfo `json:"providedSpec,omitempty"`

	// reconstructed spec
	ReconstructedSpec *SpecInfo `json:"reconstructedSpec,omitempty"`
}

type RawSpec struct {

	// created at
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt,omitempty"`

	// spec in json or yaml format
	RawSpec string `json:"rawSpec,omitempty"`
}

type ReviewPathItem struct {

	// Group of api event paths (original) that suggestedPath is representing
	APIEventsPaths []*APIEventPathAndMethods `json:"apiEventsPaths"`

	// Represents the parameterized path suggested by the engine
	SuggestedPath string `json:"suggestedPath,omitempty"`
}

type SpecDiffTime struct {

	// api event Id
	APIEventID uint32 `json:"apiEventId,omitempty"`

	// api host name
	APIHostName string `json:"apiHostName,omitempty"`

	// diff type
	DiffType *DiffType `json:"diffType,omitempty"`

	// time
	// Format: date-time
	Time strfmt.DateTime `json:"time,omitempty"`
}

type SpecInfo struct {

	// tags
	Tags []*SpecTag `json:"tags"`
}

type SpecTag struct {

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

	// method and path list
	MethodAndPathList []*MethodAndPath `json:"methodAndPathList"`

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

type SuccessResponse struct {

	// message
	Message string `json:"message,omitempty"`
}

type SuggestedReview struct {

	// id
	ID uint32 `json:"id,omitempty"`

	// review path items
	ReviewPathItems []*ReviewPathItem `json:"reviewPathItems"`
}

type TraceSource struct {

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

	// id
	ID int64 `json:"id,omitempty"`

	// Unique name identifying a Trace Source
	// Required: true
	Name *string `json:"name"`

	// token
	Token string `json:"token,omitempty"`

	// type
	// Required: true
	Type *TraceSourceType `json:"type"`

	// uid
	// Format: uuid
	UID strfmt.UUID `json:"uid,omitempty"`
}

type TraceSourceType string