package
2.4.0+incompatible
Repository: https://github.com/camptocamp/terraboard.git
Documentation: pkg.go.dev
# Functions
GetLineageActivity returns the activity (version history) of a Lineage @Summary Get Lineage activity @Description Retrieves the activity (version history) of a Lineage @ID get-lineage-activity @Produce json @Param lineage path string true "Lineage" @Success 200 {string} string "ok" @Router /lineages/{lineage}/activity [get].
GetLineages recover all Lineage from db.
GetLocks returns information on locked States @Summary Get locked states information @Description Returns information on locked States @ID get-locks @Produce json @Success 200 {string} string "ok" @Router /locks [get].
GetPlan provides a specific Plan of a lineage using ID.
GetPlans provides all Plan by lineage.
GetPlansSummary provides summary of all Plan by lineage (only metadata added by the wrapper).
GetState provides information on a State @Summary Provides information on a State @Description Retrieves a State from the database by its lineage and versionID @ID get-state @Produce json @Param versionid query string false "Version ID" @Param lineage path string true "Lineage" @Success 200 {string} string "ok" @Router /lineages/{lineage} [get].
GetUser returns information about the logged user @Summary Get logged user information @Description Returns information about the logged user @ID get-user @Produce json @Success 200 {string} string "ok" @Router /user [get].
JSONError is a wrapper function for errors which prints them to the http.ResponseWriter as a JSON response.
ListAttributeKeys lists all Resource Attribute Keys, optionally filtered by resource_type @Summary Get resource attribute keys @Description Lists all resource attribute keys, optionally filtered by resource_type @ID list-attribute-keys @Produce json @Param resource_type query string false "Resource Type" @Success 200 {string} string "ok" @Router /attribute/keys [get].
ListResourceNames lists all Resource names @Summary Get resource names @Description Lists all resource names @ID list-resource-names @Produce json @Success 200 {string} string "ok" @Router /resource/names [get].
ListResourceTypes lists all Resource types @Summary Get Resource types @Description Lists all Resource types @ID list-resource-types @Produce json @Success 200 {string} string "ok" @Router /resource/types [get].
ListResourceTypesWithCount lists all Resource types with their associated count @Summary Get resource types with count @Description Lists all resource types with their associated count @ID list-resource-types-with-count @Produce json @Success 200 {string} string "ok" @Router /resource/types/count [get].
ListStateStats returns State information for a given path as parameter @Summary Get Lineage states stats @Description Returns Lineage states stats along with paging information @ID list-state-stats @Produce json @Param page query integer false "Current page for pagination" @Success 200 {string} string "ok" @Router /lineages/stats [get].
ListTerraformVersionsWithCount lists Terraform versions with their associated counts, sorted by the 'orderBy' parameter (version by default) @Summary Lists Terraform versions with counts @Description Get terraform version with their associated counts, sorted by the 'orderBy' parameter (version by default) @ID list-terraform-versions-with-count @Produce json @Param orderBy query string false "Order by constraint" @Success 200 {string} string "ok" @Router /lineages/tfversion/count [get].
ListTfVersions lists all Terraform versions @Summary Get terraform versions @Description Lists all terraform versions @ID list-tf-versions @Produce json @Success 200 {string} string "ok" @Router /tf_versions [get].
ManagePlans is used to route the request to the appropriated handler function on /api/plans request.
SearchAttribute performs a search on Resource Attributes by various parameters @Summary Search Resource Attributes @Description Performs a search on Resource Attributes by various parameters @ID search-attribute @Produce json @Param versionid query string false "Version ID" @Param type query string false "Ressource type" @Param name query string false "Resource ID" @Param key query string false "Attribute Key" @Param value query string false "Attribute Value" @Param tf_version query string false "Terraform Version" @Param lineage_value query string false "Lineage" @Success 200 {string} string "ok" @Router /search/attribute [get].
StateCompare compares two versions ('from' and 'to') of a State @Summary Compares two versions of a State @Description Compares two versions ('from' and 'to') of a State @ID state-compare @Produce json @Param lineage path string true "Lineage" @Param from query string true "Version from" @Param to query string true "Version to" @Success 200 {string} string "ok" @Router /lineages/{lineage}/compare [get].
SubmitPlan inserts a new Terraform plan in the database.