design

README

design

import "github.com/brittonhayes/citadel/design"

Index

• Variables

Variables

var Incident = Type("Incident", func() {
    Attribute("id", UInt64, "Unique ID of the incident", func() {
        Minimum(0)
    })
    Attribute("date", String, "Date the incident occurred", func() {
        Format(FormatDate)
    })
    Attribute("date_closed", String, "Date the incident occurred", func() {
        Format(FormatDate)
    })
    Attribute("Permissions", String, "Permissions associated with incident", func() {
        Enum("admin", "analyst", "guest")
    })
    Attribute("severity", Int, "The severity of the incident", func() {
        Enum(0, 1, 2, 3, 4, 5)
    })
    Attribute("title", String, "The short title of the incident")
    Attribute("summary", String, "The detailed description of the incident")
    Attribute("scope", String, "The scope of impact of this incident")
    Attribute("responsible_party", String, "What group or individual caused the initial incident")
    Attribute("affected_customers", ArrayOf(String), "A list of the affected customers")
    Attribute("root_cause", String, "The original cause of the incident")
    Attribute("slack_channel", String, "The slack channel for incident discussions")
    Attribute("created_at", String, "When the incident was submitted", func() {
        Format(FormatDateTime)
    })
    Attribute("updated_at", String, "When the incident was last updated", func() {
        Format(FormatDateTime)
    })
})

var LimitPayload = Type("LimitPayload", func() {
    Attribute("limit", Int32, "Limit the number of results", func() {
        Minimum(0)
        Maximum(1000)
    })
})

var Vulnerability = Type("Vulnerability", func() {
    Attribute("id", UInt64, "Unique ID of the vulnerability", func() {
        Minimum(0)
    })
    Attribute("title", String, "Title of the vulnerability", func() {
        Example("CVE-2020-10")
    })
    Attribute("description", String, "Description of the vulnerability", func() {
        Example("There is a possible out of bounds write due to a use after free. This could lead to remote code execution with no additional execution privileges needed.")
    })
    Attribute("exploitable", Boolean, "If the vulnerability is exploitable")
    Attribute("cvss_score", Float32, "Severity score of the vulnerability", func() {
        Example(4.7)
    })
    Attribute("is_patchable", Boolean, "If the vulnerability is patchable")
    Attribute("is_upgradeable", Boolean, "If the vulnerability is upgradeable")
    Required("id")
})

Generated by gomarkdoc

Documentation

Index

• Variables

Variables

var Incident = Type("Incident", func() {
	Attribute("id", UInt64, "Unique ID of the incident", func() {
		Minimum(0)
	})
	Attribute("date", String, "Date the incident occurred", func() {
		Format(FormatDate)
	})
	Attribute("date_closed", String, "Date the incident occurred", func() {
		Format(FormatDate)
	})
	Attribute("Permissions", String, "Permissions associated with incident", func() {
		Enum("admin", "analyst", "guest")
	})
	Attribute("severity", Int, "The severity of the incident", func() {
		Enum(0, 1, 2, 3, 4, 5)
	})
	Attribute("title", String, "The short title of the incident")
	Attribute("summary", String, "The detailed description of the incident")
	Attribute("scope", String, "The scope of impact of this incident")
	Attribute("responsible_party", String, "What group or individual caused the initial incident")
	Attribute("affected_customers", ArrayOf(String), "A list of the affected customers")
	Attribute("root_cause", String, "The original cause of the incident")
	Attribute("slack_channel", String, "The slack channel for incident discussions")
	Attribute("created_at", String, "When the incident was submitted", func() {
		Format(FormatDateTime)
	})
	Attribute("updated_at", String, "When the incident was last updated", func() {
		Format(FormatDateTime)
	})
})

var LimitPayload = Type("LimitPayload", func() {
	Attribute("limit", Int32, "Limit the number of results", func() {
		Minimum(0)
		Maximum(1000)
	})
})

var Vulnerability = Type("Vulnerability", func() {
	Attribute("id", UInt64, "Unique ID of the vulnerability", func() {
		Minimum(0)
	})
	Attribute("title", String, "Title of the vulnerability", func() {
		Example("CVE-2020-10")
	})
	Attribute("description", String, "Description of the vulnerability", func() {
		Example("There is a possible out of bounds write due to a use after free. This could lead to remote code execution with no additional execution privileges needed.")
	})
	Attribute("exploitable", Boolean, "If the vulnerability is exploitable")
	Attribute("cvss_score", Float32, "Severity score of the vulnerability", func() {
		Example(4.7)
	})
	Attribute("is_patchable", Boolean, "If the vulnerability is patchable")
	Attribute("is_upgradeable", Boolean, "If the vulnerability is upgradeable")
	Required("id")
})