model

type FeatureAvailableInspectionType struct {
	// ID is the unique name of the InspectionType.
	ID string
	// Name is the human readable name of the InspectionType.
	Name string
}

type FeatureDependentFormElement struct {
	// ID is the unique name of this form element.
	ID string
	// Label is a human readable short name of this input element.
	Label string
	// Description is a string explaining this form input.
	Description string
}

type FeatureDependentTargetQueryElement struct {
	// ID is the unique name of this query task.
	ID string
	// LogTypeLabel is a human readable short name of the log type queried by the query task.
	LogTypeLabel string
	// LogTypeColorCode is the hex color code without the `#` prefix for the log type.
	LogTypeColorCode string
	// SampleQuery is an example query string used in this query task.
	SampleQuery string
}

type FeatureDocumentElement struct {
	// ID is the unique name of the feature task.
	ID string
	// Name is the human readable name of the feature task.
	Name string
	// Description is the string explain the feature task.
	Description string
	// Forms is the list of information about form inputs that is required from the feature task.
	Forms []FeatureDependentFormElement
	// IndirectQueryDependency is the list of query tasks that is required from this feature task but not the target query task.
	IndirectQueryDependency []FeatureIndirectDependentQueryElement
	// TargetQUeryDependency is the main query task used in this feature task.
	TargetQueryDependency FeatureDependentTargetQueryElement
	// OutputTimelines is the list of timelines(=ParentRelationship type) that can be generated by this feature task.
	OutputTimelines []FeatureOutputTimelineElement
	// AvailableInspctionType is the list of InspectionType that supports this feature task.
	AvailableInspectionTypes []FeatureAvailableInspectionType
}

type FeatureDocumentModel struct {
	// Features are the list of feature tasks defined in KHI.
	Features []FeatureDocumentElement
}

type FeatureIndirectDependentQueryElement struct {
	// ID is the unique name of this query task.
	ID string
	// LogTypeLabel is a human readable short name of the log type queried by the query task.
	LogTypeLabel string
	// LogTypeColorCode is the hex color code without the `#` prefix for the log type.
	LogTypeColorCode string
}

type FeatureOutputTimelineElement struct {
	// RelationshipID is the unique name of the relationship type.
	RelationshipID string
	// RelationshipColorCode is the hex color code without the `#` prefix for the relationship type.
	RelationshipColorCode string
	// LongName is the human readable name of the relationship
	LongName string
	// Label is the short name of the timeline. This is also used in the chip on the left side of timelines.
	Label string
	// Description is the string explains the relationship.
	Description string
}

type FormDocumentElement struct {
	// ID is the unique identifier of the form.
	ID string
	// Label is the display label for the form.
	Label string
	// Description provides a description of the form.
	Description string
	// UsedFeatures lists the features requesting this form parameter in their dependency.
	UsedFeatures []FormUsedFeatureElement
}

type FormDocumentModel struct {
	// Forms is a list of form elements for the document.
	Forms []FormDocumentElement
}

type FormUsedFeatureElement struct {
	// ID is the unique identifier of the feature.
	ID string
	// Name is the human-readable name of the feature.
	Name string
}

type InspectionTypeDocumentElement struct {
	// ID is the unique name of the InspectionType.
	ID string
	// Name is the human readable name of the InspectionType.
	Name string
	// SupportedFeatures is the list of the feature tasks usable for this InspectionType.
	SupportedFeatures []InspectionTypeDocumentElementFeature
}

type InspectionTypeDocumentElementFeature struct {
	// ID is the unique name of the feature task.
	ID string
	// Name is the human readable name of the feature task.
	Name string
	// Description is the string exlains the feature task.
	Description string
}

type InspectionTypeDocumentModel struct {
	// InspectionTypes are the list of InspectionType defind in KHI.
	InspectionTypes []InspectionTypeDocumentElement
}

type RelationshipDocumentElement struct {
	// ID is the unique identifier of the relationship.
	ID string
	// HasVisibleChip indicates whether the relationship has a visible chip on the left side of timeline name.
	HasVisibleChip bool
	// Label is the short label for the relationship.
	Label string
	// LongName is the descriptive name of the relationship.
	LongName string
	// ColorCode is the hexadecimal color code for the relationship.
	ColorCode string

	// GeneratableEvents is the list of the generatable events on the timeline of this relationship.
	GeneratableEvents []RelationshipGeneratableEvent
	// GeneratableRevisions is the list of the generatable revisions on the timeline of this relationship.
	GeneratableRevisions []RelationshipGeneratableRevisions
	// GeneratableAliases is the list of the generatable aliases on the timeline of this relationship.
	GeneratableAliases []RelationshipGeneratableAliases
}

type RelationshipDocumentModel struct {
	// Relationships is a list of relationship document elements.
	Relationships []RelationshipDocumentElement
}

type RelationshipGeneratableAliases struct {
	// ID is the unique identifier of the alias.
	ID string
	// AliasedTimelineRelationshipLabel is the label of the aliased timeline relationship.
	AliasedTimelineRelationshipLabel string
	// AliasedTimelineRelationshipColorCode is the hexadecimal color code for the aliased timeline relationship.
	AliasedTimelineRelationshipColorCode string
	// SourceLogTypeLabel is the label of the source log type.
	SourceLogTypeLabel string
	// SourceLogTypeColorCode is the hexadecimal color code for the source log type  without `#` prefix.
	SourceLogTypeColorCode string
	// Description describes the alias.
	Description string
}

type RelationshipGeneratableEvent struct {
	// ID is the unique identifier of the event.
	ID string
	// SourceLogTypeLabel is the label of the source log type.
	SourceLogTypeLabel string
	// ColorCode is the hexadecimal color code for the event without `#` prefix.
	ColorCode string
	// Description describes the event.
	Description string
}

type RelationshipGeneratableRevisions struct {
	// ID is the unique identifier of the revision state.
	ID string
	// SourceLogTypeLabel is the label of the source log type.
	SourceLogTypeLabel string
	// SourceLogTypeColorCode is the hexadecimal color code for the source log type without `#` prefix.
	SourceLogTypeColorCode string
	// RevisionStateColorCode is the hexadecimal color code for the revision state without `#` prefix.
	RevisionStateColorCode string
	// RevisionStateLabel is the label of the revision state.
	RevisionStateLabel string
	// Description describes the revision state.
	Description string
}