Documentation ¶
Index ¶
- type APICount
- type APIEvent
- type APIEventPathAndMethods
- func (m *APIEventPathAndMethods) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *APIEventPathAndMethods) MarshalBinary() ([]byte, error)
- func (m *APIEventPathAndMethods) UnmarshalBinary(b []byte) error
- func (m *APIEventPathAndMethods) Validate(formats strfmt.Registry) error
- type APIEventSortKey
- type APIEventSpecDiff
- type APIInfo
- type APIInfoWithType
- func (m *APIInfoWithType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *APIInfoWithType) MarshalBinary() ([]byte, error)
- func (m APIInfoWithType) MarshalJSON() ([]byte, error)
- func (m *APIInfoWithType) UnmarshalBinary(b []byte) error
- func (m *APIInfoWithType) UnmarshalJSON(raw []byte) error
- func (m *APIInfoWithType) Validate(formats strfmt.Registry) error
- type APIInventorySortKey
- type APIResponse
- type APIType
- type APIUsage
- type APIUsages
- type AlertSeverityEnum
- type ApprovedReview
- type DiffType
- type HTTPMethod
- type HitCount
- type MethodAndPath
- type ModuleAlert
- type OpenAPISpecs
- type RawSpec
- type ReviewPathItem
- type SpecDiffTime
- type SpecInfo
- type SpecTag
- type SuccessResponse
- type SuggestedReview
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APICount ¶
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"` }
APICount Api count
swagger:model ApiCount
func (*APICount) ContextValidate ¶
ContextValidate validate this Api count based on the context it is used
func (*APICount) MarshalBinary ¶
MarshalBinary interface implementation
func (*APICount) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type APIEvent ¶
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"` }
APIEvent Api event
swagger:model ApiEvent
func (*APIEvent) ContextValidate ¶
ContextValidate validate this Api event based on the context it is used
func (*APIEvent) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIEvent) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type APIEventPathAndMethods ¶
type APIEventPathAndMethods struct { // methods Methods []HTTPMethod `json:"methods"` // path Path string `json:"path,omitempty"` }
APIEventPathAndMethods Api event path and methods
swagger:model ApiEventPathAndMethods
func (*APIEventPathAndMethods) ContextValidate ¶
func (m *APIEventPathAndMethods) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this Api event path and methods based on the context it is used
func (*APIEventPathAndMethods) MarshalBinary ¶
func (m *APIEventPathAndMethods) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIEventPathAndMethods) UnmarshalBinary ¶
func (m *APIEventPathAndMethods) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIEventSortKey ¶
type APIEventSortKey string
APIEventSortKey Api event sort key
swagger:model ApiEventSortKey
const ( // APIEventSortKeyTime captures enum value "time" APIEventSortKeyTime APIEventSortKey = "time" // APIEventSortKeyMethod captures enum value "method" APIEventSortKeyMethod APIEventSortKey = "method" // APIEventSortKeyPath captures enum value "path" APIEventSortKeyPath APIEventSortKey = "path" // APIEventSortKeyStatusCode captures enum value "statusCode" APIEventSortKeyStatusCode APIEventSortKey = "statusCode" // APIEventSortKeySourceIP captures enum value "sourceIP" APIEventSortKeySourceIP APIEventSortKey = "sourceIP" // APIEventSortKeyDestinationIP captures enum value "destinationIP" APIEventSortKeyDestinationIP APIEventSortKey = "destinationIP" // APIEventSortKeyDestinationPort captures enum value "destinationPort" APIEventSortKeyDestinationPort APIEventSortKey = "destinationPort" // APIEventSortKeySpecDiffType captures enum value "specDiffType" APIEventSortKeySpecDiffType APIEventSortKey = "specDiffType" // APIEventSortKeyHostSpecName captures enum value "hostSpecName" APIEventSortKeyHostSpecName APIEventSortKey = "hostSpecName" // APIEventSortKeyAPIType captures enum value "apiType" APIEventSortKeyAPIType APIEventSortKey = "apiType" )
func NewAPIEventSortKey ¶
func NewAPIEventSortKey(value APIEventSortKey) *APIEventSortKey
func (APIEventSortKey) ContextValidate ¶
ContextValidate validates this Api event sort key based on context it is used
func (APIEventSortKey) Pointer ¶
func (m APIEventSortKey) Pointer() *APIEventSortKey
Pointer returns a pointer to a freshly-allocated APIEventSortKey.
type APIEventSpecDiff ¶
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"` }
APIEventSpecDiff Api event spec diff
swagger:model ApiEventSpecDiff
func (*APIEventSpecDiff) ContextValidate ¶
ContextValidate validate this Api event spec diff based on the context it is used
func (*APIEventSpecDiff) MarshalBinary ¶
func (m *APIEventSpecDiff) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIEventSpecDiff) UnmarshalBinary ¶
func (m *APIEventSpecDiff) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIInfo ¶
type APIInfo struct { // 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"` }
APIInfo Api info
swagger:model ApiInfo
func (*APIInfo) ContextValidate ¶
ContextValidate validates this Api info based on context it is used
func (*APIInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type APIInfoWithType ¶
APIInfoWithType Api info with type
swagger:model ApiInfoWithType
func (*APIInfoWithType) ContextValidate ¶
ContextValidate validate this Api info with type based on the context it is used
func (*APIInfoWithType) MarshalBinary ¶
func (m *APIInfoWithType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (APIInfoWithType) MarshalJSON ¶
func (m APIInfoWithType) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*APIInfoWithType) UnmarshalBinary ¶
func (m *APIInfoWithType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*APIInfoWithType) UnmarshalJSON ¶
func (m *APIInfoWithType) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type APIInventorySortKey ¶
type APIInventorySortKey string
APIInventorySortKey Api inventory sort key
swagger:model ApiInventorySortKey
const ( // APIInventorySortKeyName captures enum value "name" APIInventorySortKeyName APIInventorySortKey = "name" // APIInventorySortKeyPort captures enum value "port" APIInventorySortKeyPort APIInventorySortKey = "port" // APIInventorySortKeyHasReconstructedSpec captures enum value "hasReconstructedSpec" APIInventorySortKeyHasReconstructedSpec APIInventorySortKey = "hasReconstructedSpec" // APIInventorySortKeyHasProvidedSpec captures enum value "hasProvidedSpec" APIInventorySortKeyHasProvidedSpec APIInventorySortKey = "hasProvidedSpec" )
func NewAPIInventorySortKey ¶
func NewAPIInventorySortKey(value APIInventorySortKey) *APIInventorySortKey
func (APIInventorySortKey) ContextValidate ¶
ContextValidate validates this Api inventory sort key based on context it is used
func (APIInventorySortKey) Pointer ¶
func (m APIInventorySortKey) Pointer() *APIInventorySortKey
Pointer returns a pointer to a freshly-allocated APIInventorySortKey.
type APIResponse ¶
type APIResponse struct { // message Message string `json:"message,omitempty"` }
APIResponse An object that is return in all cases of failures.
swagger:model ApiResponse
func (*APIResponse) ContextValidate ¶
ContextValidate validates this Api response based on context it is used
func (*APIResponse) MarshalBinary ¶
func (m *APIResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIResponse) UnmarshalBinary ¶
func (m *APIResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIType ¶
type APIType string
APIType Api type
swagger:model ApiType
func NewAPIType ¶
func (APIType) ContextValidate ¶
ContextValidate validates this Api type based on context it is used
type APIUsage ¶
type APIUsage struct { // num of calls NumOfCalls int64 `json:"numOfCalls"` // time // Format: date-time Time strfmt.DateTime `json:"time,omitempty"` }
APIUsage Api usage
swagger:model ApiUsage
func (*APIUsage) ContextValidate ¶
ContextValidate validates this Api usage based on context it is used
func (*APIUsage) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIUsage) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type APIUsages ¶
type APIUsages struct { // apis with diff ApisWithDiff []*APIUsage `json:"apisWithDiff"` // existing apis ExistingApis []*APIUsage `json:"existingApis"` // new apis NewApis []*APIUsage `json:"newApis"` }
APIUsages Api usages
swagger:model ApiUsages
func (*APIUsages) ContextValidate ¶
ContextValidate validate this Api usages based on the context it is used
func (*APIUsages) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIUsages) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AlertSeverityEnum ¶
type AlertSeverityEnum string
AlertSeverityEnum Level of alert
swagger:model AlertSeverityEnum
const ( // AlertSeverityEnumALERTINFO captures enum value "ALERT_INFO" AlertSeverityEnumALERTINFO AlertSeverityEnum = "ALERT_INFO" // AlertSeverityEnumALERTWARN captures enum value "ALERT_WARN" AlertSeverityEnumALERTWARN AlertSeverityEnum = "ALERT_WARN" )
func NewAlertSeverityEnum ¶
func NewAlertSeverityEnum(value AlertSeverityEnum) *AlertSeverityEnum
func (AlertSeverityEnum) ContextValidate ¶
ContextValidate validates this alert severity enum based on context it is used
func (AlertSeverityEnum) Pointer ¶
func (m AlertSeverityEnum) Pointer() *AlertSeverityEnum
Pointer returns a pointer to a freshly-allocated AlertSeverityEnum.
type ApprovedReview ¶
type ApprovedReview struct { // review path items ReviewPathItems []*ReviewPathItem `json:"reviewPathItems"` }
ApprovedReview approved review
swagger:model ApprovedReview
func (*ApprovedReview) ContextValidate ¶
ContextValidate validate this approved review based on the context it is used
func (*ApprovedReview) MarshalBinary ¶
func (m *ApprovedReview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApprovedReview) UnmarshalBinary ¶
func (m *ApprovedReview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DiffType ¶
type DiffType string
DiffType diff type
swagger:model DiffType
const ( // DiffTypeZOMBIEDIFF captures enum value "ZOMBIE_DIFF" DiffTypeZOMBIEDIFF DiffType = "ZOMBIE_DIFF" // DiffTypeSHADOWDIFF captures enum value "SHADOW_DIFF" DiffTypeSHADOWDIFF DiffType = "SHADOW_DIFF" // DiffTypeGENERALDIFF captures enum value "GENERAL_DIFF" DiffTypeGENERALDIFF DiffType = "GENERAL_DIFF" // DiffTypeNODIFF captures enum value "NO_DIFF" DiffTypeNODIFF DiffType = "NO_DIFF" )
func NewDiffType ¶
func (DiffType) ContextValidate ¶
ContextValidate validates this diff type based on context it is used
type HTTPMethod ¶
type HTTPMethod string
HTTPMethod Http method
swagger:model HttpMethod
const ( // HTTPMethodGET captures enum value "GET" HTTPMethodGET HTTPMethod = "GET" // HTTPMethodHEAD captures enum value "HEAD" HTTPMethodHEAD HTTPMethod = "HEAD" // HTTPMethodPOST captures enum value "POST" HTTPMethodPOST HTTPMethod = "POST" // HTTPMethodPUT captures enum value "PUT" HTTPMethodPUT HTTPMethod = "PUT" // HTTPMethodDELETE captures enum value "DELETE" HTTPMethodDELETE HTTPMethod = "DELETE" // HTTPMethodCONNECT captures enum value "CONNECT" HTTPMethodCONNECT HTTPMethod = "CONNECT" // HTTPMethodOPTIONS captures enum value "OPTIONS" HTTPMethodOPTIONS HTTPMethod = "OPTIONS" // HTTPMethodTRACE captures enum value "TRACE" HTTPMethodTRACE HTTPMethod = "TRACE" // HTTPMethodPATCH captures enum value "PATCH" HTTPMethodPATCH HTTPMethod = "PATCH" )
func NewHTTPMethod ¶
func NewHTTPMethod(value HTTPMethod) *HTTPMethod
func (HTTPMethod) ContextValidate ¶
ContextValidate validates this Http method based on context it is used
func (HTTPMethod) Pointer ¶
func (m HTTPMethod) Pointer() *HTTPMethod
Pointer returns a pointer to a freshly-allocated HTTPMethod.
type HitCount ¶
type HitCount struct { // count Count int64 `json:"count"` // time // Format: date-time Time strfmt.DateTime `json:"time,omitempty"` }
HitCount hit count
swagger:model HitCount
func (*HitCount) ContextValidate ¶
ContextValidate validates this hit count based on context it is used
func (*HitCount) MarshalBinary ¶
MarshalBinary interface implementation
func (*HitCount) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MethodAndPath ¶
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"` }
MethodAndPath method and path
swagger:model MethodAndPath
func (*MethodAndPath) ContextValidate ¶
ContextValidate validate this method and path based on the context it is used
func (*MethodAndPath) MarshalBinary ¶
func (m *MethodAndPath) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MethodAndPath) UnmarshalBinary ¶
func (m *MethodAndPath) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ModuleAlert ¶
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"` }
ModuleAlert module alert
swagger:model ModuleAlert
func (*ModuleAlert) ContextValidate ¶
ContextValidate validate this module alert based on the context it is used
func (*ModuleAlert) MarshalBinary ¶
func (m *ModuleAlert) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ModuleAlert) UnmarshalBinary ¶
func (m *ModuleAlert) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OpenAPISpecs ¶
type OpenAPISpecs struct { // provided spec ProvidedSpec *SpecInfo `json:"providedSpec,omitempty"` // reconstructed spec ReconstructedSpec *SpecInfo `json:"reconstructedSpec,omitempty"` }
OpenAPISpecs An object representing the provided and reconstructed API specs
swagger:model OpenApiSpecs
func (*OpenAPISpecs) ContextValidate ¶
ContextValidate validate this open Api specs based on the context it is used
func (*OpenAPISpecs) MarshalBinary ¶
func (m *OpenAPISpecs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OpenAPISpecs) UnmarshalBinary ¶
func (m *OpenAPISpecs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RawSpec ¶
type RawSpec struct { // spec in json or yaml format RawSpec string `json:"rawSpec,omitempty"` }
RawSpec spec in json or yaml format
swagger:model rawSpec
func (*RawSpec) ContextValidate ¶
ContextValidate validates this raw spec based on context it is used
func (*RawSpec) MarshalBinary ¶
MarshalBinary interface implementation
func (*RawSpec) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ReviewPathItem ¶
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"` }
ReviewPathItem review path item
swagger:model ReviewPathItem
func (*ReviewPathItem) ContextValidate ¶
ContextValidate validate this review path item based on the context it is used
func (*ReviewPathItem) MarshalBinary ¶
func (m *ReviewPathItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReviewPathItem) UnmarshalBinary ¶
func (m *ReviewPathItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SpecDiffTime ¶
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"` }
SpecDiffTime spec diff time
swagger:model SpecDiffTime
func (*SpecDiffTime) ContextValidate ¶
ContextValidate validate this spec diff time based on the context it is used
func (*SpecDiffTime) MarshalBinary ¶
func (m *SpecDiffTime) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SpecDiffTime) UnmarshalBinary ¶
func (m *SpecDiffTime) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SpecInfo ¶
type SpecInfo struct { // tags Tags []*SpecTag `json:"tags"` }
SpecInfo An object containing info about a spec
swagger:model SpecInfo
func (*SpecInfo) ContextValidate ¶
ContextValidate validate this spec info based on the context it is used
func (*SpecInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*SpecInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SpecTag ¶
type SpecTag struct { // description Description string `json:"description,omitempty"` // method and path list MethodAndPathList []*MethodAndPath `json:"methodAndPathList"` // name Name string `json:"name,omitempty"` }
SpecTag spec tag
swagger:model SpecTag
func (*SpecTag) ContextValidate ¶
ContextValidate validate this spec tag based on the context it is used
func (*SpecTag) MarshalBinary ¶
MarshalBinary interface implementation
func (*SpecTag) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SuccessResponse ¶
type SuccessResponse struct { // message Message string `json:"message,omitempty"` }
SuccessResponse An object that is return in cases of success that return nothing.
swagger:model SuccessResponse
func (*SuccessResponse) ContextValidate ¶
ContextValidate validates this success response based on context it is used
func (*SuccessResponse) MarshalBinary ¶
func (m *SuccessResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SuccessResponse) UnmarshalBinary ¶
func (m *SuccessResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SuggestedReview ¶
type SuggestedReview struct { // id ID uint32 `json:"id,omitempty"` // review path items ReviewPathItems []*ReviewPathItem `json:"reviewPathItems"` }
SuggestedReview suggested review
swagger:model SuggestedReview
func (*SuggestedReview) ContextValidate ¶
ContextValidate validate this suggested review based on the context it is used
func (*SuggestedReview) MarshalBinary ¶
func (m *SuggestedReview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SuggestedReview) UnmarshalBinary ¶
func (m *SuggestedReview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files ¶
- alert_severity_enum.go
- api_count.go
- api_event.go
- api_event_path_and_methods.go
- api_event_sort_key.go
- api_event_spec_diff.go
- api_info.go
- api_info_with_type.go
- api_inventory_sort_key.go
- api_response.go
- api_type.go
- api_usage.go
- api_usages.go
- approved_review.go
- diff_type.go
- hit_count.go
- http_method.go
- method_and_path.go
- module_alert.go
- open_api_specs.go
- raw_spec.go
- review_path_item.go
- spec_diff_time.go
- spec_info.go
- spec_tag.go
- success_response.go
- suggested_review.go