From 751db02e19da6a5985ab1af9930807d3bc126539 Mon Sep 17 00:00:00 2001 From: Kyle Date: Tue, 28 Jan 2025 15:03:35 -0600 Subject: [PATCH] Implement Component Types (#510) * Implement Component Types * add changie * fix lint --- .../unreleased/Feature-20250127-150003.yaml | 3 + component.go | 107 +++ component_test.go | 113 +++ enum.go | 795 +++++++++--------- testdata/templates/component_type.tpl | 48 ++ 5 files changed, 665 insertions(+), 401 deletions(-) create mode 100644 .changes/unreleased/Feature-20250127-150003.yaml create mode 100644 component.go create mode 100644 component_test.go create mode 100644 testdata/templates/component_type.tpl diff --git a/.changes/unreleased/Feature-20250127-150003.yaml b/.changes/unreleased/Feature-20250127-150003.yaml new file mode 100644 index 00000000..1a4e11cd --- /dev/null +++ b/.changes/unreleased/Feature-20250127-150003.yaml @@ -0,0 +1,3 @@ +kind: Feature +body: Add ability to CRUD 'ComponentType' +time: 2025-01-27T15:00:03.646584-06:00 diff --git a/component.go b/component.go new file mode 100644 index 00000000..0914b5fe --- /dev/null +++ b/component.go @@ -0,0 +1,107 @@ +package opslevel + +// ComponentTypeId Information about a particular component type +type ComponentTypeId Identifier + +// ComponentType Information about a particular component type +type ComponentType struct { + ComponentTypeId + Description string // The description of the component type (Optional) + Href string // The relative path to link to the component type (Required) + Icon ComponentTypeIcon // The icon associated with the component type (Required) + IsDefault bool // Whether or not the component type is the default (Required) + Name string // The name of the component type (Required) + Timestamps Timestamps // When the component type was created and updated (Required) +} + +// ComponentTypeIcon The icon for a component type +type ComponentTypeIcon struct { + Color string // The color, represented as a hexcode, for the icon (Optional) + Name string // The name of the icon in Phosphor icons for Vue, e.g. `PhBird`. See https://phosphoricons.com/ for a full list (Optional) +} + +type ComponentTypeConnection struct { + Nodes []ComponentType `json:"nodes"` + PageInfo PageInfo `json:"pageInfo"` + TotalCount int `json:"totalCount" graphql:"-"` +} + +func (client *Client) CreateComponentType(input ComponentTypeInput) (*ComponentType, error) { + var m struct { + Payload struct { + ComponentType ComponentType + Errors []OpsLevelErrors + } `graphql:"componentTypeCreate(input:$input)"` + } + v := PayloadVariables{ + "input": input, + } + err := client.Mutate(&m, v, WithName("ComponentTypeCreate")) + return &m.Payload.ComponentType, HandleErrors(err, m.Payload.Errors) +} + +func (client *Client) GetComponentType(identifier string) (*ComponentType, error) { + var q struct { + Account struct { + ComponentType ComponentType `graphql:"componentType(input: $input)"` + } + } + v := PayloadVariables{ + "input": *NewIdentifier(identifier), + } + err := client.Query(&q, v, WithName("ComponentTypeGet")) + return &q.Account.ComponentType, HandleErrors(err, nil) +} + +func (client *Client) ListComponentTypes(variables *PayloadVariables) (*ComponentTypeConnection, error) { + var q struct { + Account struct { + ComponentTypes ComponentTypeConnection `graphql:"componentTypes(after: $after, first: $first)"` + } + } + if variables == nil { + variables = client.InitialPageVariablesPointer() + } + if err := client.Query(&q, *variables, WithName("ComponentTypeList")); err != nil { + return nil, err + } + for q.Account.ComponentTypes.PageInfo.HasNextPage { + (*variables)["after"] = q.Account.ComponentTypes.PageInfo.End + resp, err := client.ListComponentTypes(variables) + if err != nil { + return nil, err + } + q.Account.ComponentTypes.Nodes = append(q.Account.ComponentTypes.Nodes, resp.Nodes...) + q.Account.ComponentTypes.PageInfo = resp.PageInfo + } + q.Account.ComponentTypes.TotalCount = len(q.Account.ComponentTypes.Nodes) + return &q.Account.ComponentTypes, nil +} + +func (client *Client) UpdateComponentType(identifier string, input ComponentTypeInput) (*ComponentType, error) { + var m struct { + Payload struct { + ComponentType ComponentType + Errors []OpsLevelErrors + } `graphql:"componentTypeUpdate(componentType:$target,input:$input)"` + } + v := PayloadVariables{ + "target": *NewIdentifier(identifier), + "input": input, + } + err := client.Mutate(&m, v, WithName("ComponentTypeUpdate")) + return &m.Payload.ComponentType, HandleErrors(err, m.Payload.Errors) +} + +func (client *Client) DeleteComponentType(identifier string) error { + var d struct { + Payload struct { + Errors []OpsLevelErrors `graphql:"errors"` + } `graphql:"componentTypeDelete(resource:$target)"` + } + v := PayloadVariables{ + "target": *NewIdentifier(identifier), + } + err := client.Mutate(&d, v, WithName("ComponentTypeDelete")) + return HandleErrors(err, d.Payload.Errors) +} diff --git a/component_test.go b/component_test.go new file mode 100644 index 00000000..bb53801a --- /dev/null +++ b/component_test.go @@ -0,0 +1,113 @@ +package opslevel_test + +import ( + "testing" + + ol "github.com/opslevel/opslevel-go/v2024" + "github.com/rocktavious/autopilot/v2023" +) + +func TestComponentTypeCreate(t *testing.T) { + // Arrange + input := autopilot.Register[ol.ComponentTypeInput]("component_type_create_input", + ol.ComponentTypeInput{ + Alias: ol.RefOf("example"), + Name: ol.RefOf("Example"), + Description: ol.RefOf("Example Description"), + Properties: &[]ol.ComponentTypePropertyDefinitionInput{}, + }) + + testRequest := autopilot.NewTestRequest( + `mutation ComponentTypeCreate($input:ComponentTypeInput!){componentTypeCreate(input:$input){componentType{{ template "component_type_graphql" }},errors{message,path}}}`, + `{"input": {"alias": "example", "name": "Example", "description": "Example Description", "properties": []} }`, + `{"data": {"componentTypeCreate": {"componentType": {{ template "component_type_1_response" }} }}}`, + ) + + client := BestTestClient(t, "ComponentType/create", testRequest) + // Act + result, err := client.CreateComponentType(input) + // Assert + autopilot.Ok(t, err) + autopilot.Equals(t, id1, result.Id) +} + +func TestComponentTypeGet(t *testing.T) { + // Arrange + testRequest := autopilot.NewTestRequest( + `query ComponentTypeGet($input:IdentifierInput!){account{componentType(input: $input){{ template "component_type_graphql" }}}}`, + `{"input": { {{ template "id1" }} }}`, + `{"data": {"account": {"componentType": {{ template "component_type_1_response" }} }}}`, + ) + + client := BestTestClient(t, "ComponentType/get", testRequest) + // Act + result, err := client.GetComponentType(string(id1)) + // Assert + autopilot.Ok(t, err) + autopilot.Equals(t, id1, result.Id) +} + +func TestComponentTypeList(t *testing.T) { + // Arrange + testRequestOne := autopilot.NewTestRequest( + `query ComponentTypeList($after:String!$first:Int!){account{componentTypes(after: $after, first: $first){nodes{{ template "component_type_graphql" }},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor}}}}`, + `{{ template "pagination_initial_query_variables" }}`, + `{ "data": { "account": { "componentTypes": { "nodes": [ {{ template "component_type_1_response" }}, {{ template "component_type_2_response" }} ], {{ template "pagination_initial_pageInfo_response" }} }}}}`, + ) + testRequestTwo := autopilot.NewTestRequest( + `query ComponentTypeList($after:String!$first:Int!){account{componentTypes(after: $after, first: $first){nodes{{ template "component_type_graphql" }},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor}}}}`, + `{{ template "pagination_second_query_variables" }}`, + `{ "data": { "account": { "componentTypes": { "nodes": [ {{ template "component_type_3_response" }} ], {{ template "pagination_second_pageInfo_response" }} }}}}`, + ) + requests := []autopilot.TestRequest{testRequestOne, testRequestTwo} + + client := BestTestClient(t, "ComponentType/list", requests...) + // Act + response, err := client.ListComponentTypes(nil) + result := response.Nodes + // Assert + autopilot.Ok(t, err) + autopilot.Equals(t, 3, response.TotalCount) + autopilot.Equals(t, "Example1", result[0].Name) + autopilot.Equals(t, "Example2", result[1].Name) + autopilot.Equals(t, "Example3", result[2].Name) +} + +func TestComponentTypeUpdate(t *testing.T) { + // Arrange + input := autopilot.Register[ol.ComponentTypeInput]("component_type_update_input", + ol.ComponentTypeInput{ + Alias: ol.RefOf("example"), + Name: ol.RefOf("Example"), + Description: ol.RefOf("Example Description"), + Properties: &[]ol.ComponentTypePropertyDefinitionInput{}, + }) + + testRequest := autopilot.NewTestRequest( + `mutation ComponentTypeUpdate($input:ComponentTypeInput!$target:IdentifierInput!){componentTypeUpdate(componentType:$target,input:$input){componentType{{ template "component_type_graphql" }},errors{message,path}}}`, + `{"input": {"alias": "example", "name": "Example", "description": "Example Description", "properties": []}, "target": { {{ template "id1" }} }}`, + `{"data": {"componentTypeUpdate": {"componentType": {{ template "component_type_1_response" }} }}}`, + ) + + client := BestTestClient(t, "ComponentType/update", testRequest) + // Act + result, err := client.UpdateComponentType(string(id1), input) + // Assert + autopilot.Ok(t, err) + autopilot.Equals(t, id1, result.Id) +} + +func TestComponentTypeDelete(t *testing.T) { + // Arrange + testRequest := autopilot.NewTestRequest( + `mutation ComponentTypeDelete($target:IdentifierInput!){componentTypeDelete(resource:$target){errors{message,path}}}`, + `{"target": { {{ template "id1" }} }}`, + `{"data": {"componentTypeDelete": {"errors": [] }}}`, + ) + + client := BestTestClient(t, "ComponentType/delete", testRequest) + // Act + err := client.DeleteComponentType(string(id1)) + // Assert + autopilot.Ok(t, err) +} diff --git a/enum.go b/enum.go index bd1ff121..fc3f3ab5 100644 --- a/enum.go +++ b/enum.go @@ -1,16 +1,15 @@ -// Code generated by gen.go; DO NOT EDIT. - +// Code generated; DO NOT EDIT. package opslevel -// AlertSourceStatusTypeEnum represents the monitor status level. +// AlertSourceStatusTypeEnum The monitor status level type AlertSourceStatusTypeEnum string var ( - AlertSourceStatusTypeEnumAlert AlertSourceStatusTypeEnum = "alert" // Monitor is reporting an alert. - AlertSourceStatusTypeEnumFetchingData AlertSourceStatusTypeEnum = "fetching_data" // Monitor currently being updated. - AlertSourceStatusTypeEnumNoData AlertSourceStatusTypeEnum = "no_data" // No data received yet. Ensure your monitors are configured correctly. - AlertSourceStatusTypeEnumOk AlertSourceStatusTypeEnum = "ok" // Monitor is not reporting any warnings or alerts. - AlertSourceStatusTypeEnumWarn AlertSourceStatusTypeEnum = "warn" // Monitor is reporting a warning. + AlertSourceStatusTypeEnumAlert AlertSourceStatusTypeEnum = "alert" // Monitor is reporting an alert + AlertSourceStatusTypeEnumFetchingData AlertSourceStatusTypeEnum = "fetching_data" // Monitor currently being updated + AlertSourceStatusTypeEnumNoData AlertSourceStatusTypeEnum = "no_data" // No data received yet. Ensure your monitors are configured correctly + AlertSourceStatusTypeEnumOk AlertSourceStatusTypeEnum = "ok" // Monitor is not reporting any warnings or alerts + AlertSourceStatusTypeEnumWarn AlertSourceStatusTypeEnum = "warn" // Monitor is reporting a warning ) // All AlertSourceStatusTypeEnum as []string @@ -22,15 +21,15 @@ var AllAlertSourceStatusTypeEnum = []string{ string(AlertSourceStatusTypeEnumWarn), } -// AlertSourceTypeEnum represents the type of the alert source. +// AlertSourceTypeEnum The type of the alert source type AlertSourceTypeEnum string var ( - AlertSourceTypeEnumDatadog AlertSourceTypeEnum = "datadog" // A Datadog alert source (aka monitor). - AlertSourceTypeEnumIncidentIo AlertSourceTypeEnum = "incident_io" // An incident.io alert source (aka service). - AlertSourceTypeEnumNewRelic AlertSourceTypeEnum = "new_relic" // A New Relic alert source (aka service). - AlertSourceTypeEnumOpsgenie AlertSourceTypeEnum = "opsgenie" // An Opsgenie alert source (aka service). - AlertSourceTypeEnumPagerduty AlertSourceTypeEnum = "pagerduty" // A PagerDuty alert source (aka service). + AlertSourceTypeEnumDatadog AlertSourceTypeEnum = "datadog" // A Datadog alert source (aka monitor) + AlertSourceTypeEnumIncidentIo AlertSourceTypeEnum = "incident_io" // An incident.io alert source (aka service) + AlertSourceTypeEnumNewRelic AlertSourceTypeEnum = "new_relic" // A New Relic alert source (aka service) + AlertSourceTypeEnumOpsgenie AlertSourceTypeEnum = "opsgenie" // An Opsgenie alert source (aka service) + AlertSourceTypeEnumPagerduty AlertSourceTypeEnum = "pagerduty" // A PagerDuty alert source (aka service) ) // All AlertSourceTypeEnum as []string @@ -42,17 +41,17 @@ var AllAlertSourceTypeEnum = []string{ string(AlertSourceTypeEnumPagerduty), } -// AliasOwnerTypeEnum represents the owner type an alias is assigned to. +// AliasOwnerTypeEnum The owner type an alias is assigned to type AliasOwnerTypeEnum string var ( - AliasOwnerTypeEnumDomain AliasOwnerTypeEnum = "domain" // Aliases that are assigned to domains. - AliasOwnerTypeEnumGroup AliasOwnerTypeEnum = "group" // Aliases that are assigned to groups. - AliasOwnerTypeEnumInfrastructureResource AliasOwnerTypeEnum = "infrastructure_resource" // Aliases that are assigned to infrastructure resources. - AliasOwnerTypeEnumScorecard AliasOwnerTypeEnum = "scorecard" // Aliases that are assigned to scorecards. - AliasOwnerTypeEnumService AliasOwnerTypeEnum = "service" // Aliases that are assigned to services. - AliasOwnerTypeEnumSystem AliasOwnerTypeEnum = "system" // Aliases that are assigned to systems. - AliasOwnerTypeEnumTeam AliasOwnerTypeEnum = "team" // Aliases that are assigned to teams. + AliasOwnerTypeEnumDomain AliasOwnerTypeEnum = "domain" // Aliases that are assigned to domains + AliasOwnerTypeEnumGroup AliasOwnerTypeEnum = "group" // Aliases that are assigned to groups + AliasOwnerTypeEnumInfrastructureResource AliasOwnerTypeEnum = "infrastructure_resource" // Aliases that are assigned to infrastructure resources + AliasOwnerTypeEnumScorecard AliasOwnerTypeEnum = "scorecard" // Aliases that are assigned to scorecards + AliasOwnerTypeEnumService AliasOwnerTypeEnum = "service" // Aliases that are assigned to services + AliasOwnerTypeEnumSystem AliasOwnerTypeEnum = "system" // Aliases that are assigned to systems + AliasOwnerTypeEnumTeam AliasOwnerTypeEnum = "team" // Aliases that are assigned to teams ) // All AliasOwnerTypeEnum as []string @@ -66,12 +65,12 @@ var AllAliasOwnerTypeEnum = []string{ string(AliasOwnerTypeEnumTeam), } -// ApiDocumentSourceEnum represents the source used to determine the preferred API document. +// ApiDocumentSourceEnum The source used to determine the preferred API document type ApiDocumentSourceEnum string var ( - ApiDocumentSourceEnumPull ApiDocumentSourceEnum = "PULL" // Use the document that was pulled by OpsLevel via a repo. - ApiDocumentSourceEnumPush ApiDocumentSourceEnum = "PUSH" // Use the document that was pushed to OpsLevel via an API Docs integration. + ApiDocumentSourceEnumPull ApiDocumentSourceEnum = "PULL" // Use the document that was pulled by OpsLevel via a repo + ApiDocumentSourceEnumPush ApiDocumentSourceEnum = "PUSH" // Use the document that was pushed to OpsLevel via an API Docs integration ) // All ApiDocumentSourceEnum as []string @@ -80,12 +79,12 @@ var AllApiDocumentSourceEnum = []string{ string(ApiDocumentSourceEnumPush), } -// BasicTypeEnum represents operations that can be used on filters. +// BasicTypeEnum Operations that can be used on filters type BasicTypeEnum string var ( - BasicTypeEnumDoesNotEqual BasicTypeEnum = "does_not_equal" // Does not equal a specific value. - BasicTypeEnumEquals BasicTypeEnum = "equals" // Equals a specific value. + BasicTypeEnumDoesNotEqual BasicTypeEnum = "does_not_equal" // Does not equal a specific value + BasicTypeEnumEquals BasicTypeEnum = "equals" // Equals a specific value ) // All BasicTypeEnum as []string @@ -94,13 +93,13 @@ var AllBasicTypeEnum = []string{ string(BasicTypeEnumEquals), } -// CampaignFilterEnum represents fields that can be used as part of filter for campaigns. +// CampaignFilterEnum Fields that can be used as part of filter for campaigns type CampaignFilterEnum string var ( - CampaignFilterEnumID CampaignFilterEnum = "id" // Filter by `id` of campaign. - CampaignFilterEnumOwner CampaignFilterEnum = "owner" // Filter by campaign owner. - CampaignFilterEnumStatus CampaignFilterEnum = "status" // Filter by campaign status. + CampaignFilterEnumID CampaignFilterEnum = "id" // Filter by `id` of campaign + CampaignFilterEnumOwner CampaignFilterEnum = "owner" // Filter by campaign owner + CampaignFilterEnumStatus CampaignFilterEnum = "status" // Filter by campaign status ) // All CampaignFilterEnum as []string @@ -110,13 +109,13 @@ var AllCampaignFilterEnum = []string{ string(CampaignFilterEnumStatus), } -// CampaignReminderChannelEnum represents the possible communication channels through which a campaign reminder can be delivered. +// CampaignReminderChannelEnum The possible communication channels through which a campaign reminder can be delivered type CampaignReminderChannelEnum string var ( - CampaignReminderChannelEnumEmail CampaignReminderChannelEnum = "email" // A system for sending messages to one or more recipients via telecommunications links between computers using dedicated software or a web-based service. - CampaignReminderChannelEnumMicrosoftTeams CampaignReminderChannelEnum = "microsoft_teams" // A proprietary business communication platform developed by Microsoft. - CampaignReminderChannelEnumSlack CampaignReminderChannelEnum = "slack" // A cloud-based team communication platform developed by Slack Technologies. + CampaignReminderChannelEnumEmail CampaignReminderChannelEnum = "email" // A system for sending messages to one or more recipients via telecommunications links between computers using dedicated software or a web-based service + CampaignReminderChannelEnumMicrosoftTeams CampaignReminderChannelEnum = "microsoft_teams" // A proprietary business communication platform developed by Microsoft + CampaignReminderChannelEnumSlack CampaignReminderChannelEnum = "slack" // A cloud-based team communication platform developed by Slack Technologies ) // All CampaignReminderChannelEnum as []string @@ -126,13 +125,13 @@ var AllCampaignReminderChannelEnum = []string{ string(CampaignReminderChannelEnumSlack), } -// CampaignReminderFrequencyUnitEnum represents possible time units for the frequency at which campaign reminders are delivered. +// CampaignReminderFrequencyUnitEnum Possible time units for the frequency at which campaign reminders are delivered type CampaignReminderFrequencyUnitEnum string var ( - CampaignReminderFrequencyUnitEnumDay CampaignReminderFrequencyUnitEnum = "day" // A period of twenty-four hours as a unit of time, reckoned from one midnight to the next, corresponding to a rotation of the earth on its axis. - CampaignReminderFrequencyUnitEnumMonth CampaignReminderFrequencyUnitEnum = "month" // Each of the twelve named periods into which a year is divided. - CampaignReminderFrequencyUnitEnumWeek CampaignReminderFrequencyUnitEnum = "week" // A period of seven days. + CampaignReminderFrequencyUnitEnumDay CampaignReminderFrequencyUnitEnum = "day" // A period of twenty-four hours as a unit of time, reckoned from one midnight to the next, corresponding to a rotation of the earth on its axis + CampaignReminderFrequencyUnitEnumMonth CampaignReminderFrequencyUnitEnum = "month" // Each of the twelve named periods into which a year is divided + CampaignReminderFrequencyUnitEnumWeek CampaignReminderFrequencyUnitEnum = "week" // A period of seven days ) // All CampaignReminderFrequencyUnitEnum as []string @@ -142,13 +141,13 @@ var AllCampaignReminderFrequencyUnitEnum = []string{ string(CampaignReminderFrequencyUnitEnumWeek), } -// CampaignReminderTypeEnum represents type/Format of the notification. +// CampaignReminderTypeEnum Type/Format of the notification type CampaignReminderTypeEnum string var ( - CampaignReminderTypeEnumEmail CampaignReminderTypeEnum = "email" // Notification will be sent via email. - CampaignReminderTypeEnumMicrosoftTeams CampaignReminderTypeEnum = "microsoft_teams" // Notification will be sent by microsoft teams. - CampaignReminderTypeEnumSlack CampaignReminderTypeEnum = "slack" // Notification will be sent by slack. + CampaignReminderTypeEnumEmail CampaignReminderTypeEnum = "email" // Notification will be sent via email + CampaignReminderTypeEnumMicrosoftTeams CampaignReminderTypeEnum = "microsoft_teams" // Notification will be sent by microsoft teams + CampaignReminderTypeEnumSlack CampaignReminderTypeEnum = "slack" // Notification will be sent by slack ) // All CampaignReminderTypeEnum as []string @@ -158,12 +157,12 @@ var AllCampaignReminderTypeEnum = []string{ string(CampaignReminderTypeEnumSlack), } -// CampaignServiceStatusEnum represents status of whether a service is passing all checks for a campaign or not. +// CampaignServiceStatusEnum Status of whether a service is passing all checks for a campaign or not type CampaignServiceStatusEnum string var ( - CampaignServiceStatusEnumFailing CampaignServiceStatusEnum = "failing" // Service is failing one or more checks in the campaign. - CampaignServiceStatusEnumPassing CampaignServiceStatusEnum = "passing" // Service is passing all the checks in the campaign. + CampaignServiceStatusEnumFailing CampaignServiceStatusEnum = "failing" // Service is failing one or more checks in the campaign + CampaignServiceStatusEnumPassing CampaignServiceStatusEnum = "passing" // Service is passing all the checks in the campaign ) // All CampaignServiceStatusEnum as []string @@ -172,28 +171,28 @@ var AllCampaignServiceStatusEnum = []string{ string(CampaignServiceStatusEnumPassing), } -// CampaignSortEnum represents sort possibilities for campaigns. +// CampaignSortEnum Sort possibilities for campaigns type CampaignSortEnum string var ( - CampaignSortEnumChecksPassingAsc CampaignSortEnum = "checks_passing_ASC" // Sort by number of `checks passing` ascending. - CampaignSortEnumChecksPassingDesc CampaignSortEnum = "checks_passing_DESC" // Sort by number of `checks passing` descending. - CampaignSortEnumEndedDateAsc CampaignSortEnum = "ended_date_ASC" // Sort by `endedDate` ascending. - CampaignSortEnumEndedDateDesc CampaignSortEnum = "ended_date_DESC" // Sort by `endedDate` descending. - CampaignSortEnumFilterAsc CampaignSortEnum = "filter_ASC" // Sort by `filter` ascending. - CampaignSortEnumFilterDesc CampaignSortEnum = "filter_DESC" // Sort by `filter` descending. - CampaignSortEnumNameAsc CampaignSortEnum = "name_ASC" // Sort by `name` ascending. - CampaignSortEnumNameDesc CampaignSortEnum = "name_DESC" // Sort by `name` descending. - CampaignSortEnumOwnerAsc CampaignSortEnum = "owner_ASC" // Sort by `owner` ascending. - CampaignSortEnumOwnerDesc CampaignSortEnum = "owner_DESC" // Sort by `owner` descending. - CampaignSortEnumServicesCompleteAsc CampaignSortEnum = "services_complete_ASC" // Sort by number of `services complete` ascending. - CampaignSortEnumServicesCompleteDesc CampaignSortEnum = "services_complete_DESC" // Sort by number of `services complete` descending. - CampaignSortEnumStartDateAsc CampaignSortEnum = "start_date_ASC" // Sort by `startDate` ascending. - CampaignSortEnumStartDateDesc CampaignSortEnum = "start_date_DESC" // Sort by `startDate` descending. - CampaignSortEnumStatusAsc CampaignSortEnum = "status_ASC" // Sort by `status` ascending. - CampaignSortEnumStatusDesc CampaignSortEnum = "status_DESC" // Sort by `status` descending. - CampaignSortEnumTargetDateAsc CampaignSortEnum = "target_date_ASC" // Sort by `targetDate` ascending. - CampaignSortEnumTargetDateDesc CampaignSortEnum = "target_date_DESC" // Sort by `targetDate` descending. + CampaignSortEnumChecksPassingAsc CampaignSortEnum = "checks_passing_ASC" // Sort by number of `checks passing` ascending + CampaignSortEnumChecksPassingDesc CampaignSortEnum = "checks_passing_DESC" // Sort by number of `checks passing` descending + CampaignSortEnumEndedDateAsc CampaignSortEnum = "ended_date_ASC" // Sort by `endedDate` ascending + CampaignSortEnumEndedDateDesc CampaignSortEnum = "ended_date_DESC" // Sort by `endedDate` descending + CampaignSortEnumFilterAsc CampaignSortEnum = "filter_ASC" // Sort by `filter` ascending + CampaignSortEnumFilterDesc CampaignSortEnum = "filter_DESC" // Sort by `filter` descending + CampaignSortEnumNameAsc CampaignSortEnum = "name_ASC" // Sort by `name` ascending + CampaignSortEnumNameDesc CampaignSortEnum = "name_DESC" // Sort by `name` descending + CampaignSortEnumOwnerAsc CampaignSortEnum = "owner_ASC" // Sort by `owner` ascending + CampaignSortEnumOwnerDesc CampaignSortEnum = "owner_DESC" // Sort by `owner` descending + CampaignSortEnumServicesCompleteAsc CampaignSortEnum = "services_complete_ASC" // Sort by number of `services complete` ascending + CampaignSortEnumServicesCompleteDesc CampaignSortEnum = "services_complete_DESC" // Sort by number of `services complete` descending + CampaignSortEnumStartDateAsc CampaignSortEnum = "start_date_ASC" // Sort by `startDate` ascending + CampaignSortEnumStartDateDesc CampaignSortEnum = "start_date_DESC" // Sort by `startDate` descending + CampaignSortEnumStatusAsc CampaignSortEnum = "status_ASC" // Sort by `status` ascending + CampaignSortEnumStatusDesc CampaignSortEnum = "status_DESC" // Sort by `status` descending + CampaignSortEnumTargetDateAsc CampaignSortEnum = "target_date_ASC" // Sort by `targetDate` ascending + CampaignSortEnumTargetDateDesc CampaignSortEnum = "target_date_DESC" // Sort by `targetDate` descending ) // All CampaignSortEnum as []string @@ -218,15 +217,15 @@ var AllCampaignSortEnum = []string{ string(CampaignSortEnumTargetDateDesc), } -// CampaignStatusEnum represents the campaign status. +// CampaignStatusEnum The campaign status type CampaignStatusEnum string var ( - CampaignStatusEnumDelayed CampaignStatusEnum = "delayed" // Campaign is delayed. - CampaignStatusEnumDraft CampaignStatusEnum = "draft" // Campaign has been created but is not yet active. - CampaignStatusEnumEnded CampaignStatusEnum = "ended" // Campaign ended. - CampaignStatusEnumInProgress CampaignStatusEnum = "in_progress" // Campaign is in progress. - CampaignStatusEnumScheduled CampaignStatusEnum = "scheduled" // Campaign has been scheduled to begin in the future. + CampaignStatusEnumDelayed CampaignStatusEnum = "delayed" // Campaign is delayed + CampaignStatusEnumDraft CampaignStatusEnum = "draft" // Campaign has been created but is not yet active + CampaignStatusEnumEnded CampaignStatusEnum = "ended" // Campaign ended + CampaignStatusEnumInProgress CampaignStatusEnum = "in_progress" // Campaign is in progress + CampaignStatusEnumScheduled CampaignStatusEnum = "scheduled" // Campaign has been scheduled to begin in the future ) // All CampaignStatusEnum as []string @@ -238,13 +237,13 @@ var AllCampaignStatusEnum = []string{ string(CampaignStatusEnumScheduled), } -// CheckCodeIssueConstraintEnum represents the values allowed for the constraint type for the code issues check. +// CheckCodeIssueConstraintEnum The values allowed for the constraint type for the code issues check type CheckCodeIssueConstraintEnum string var ( - CheckCodeIssueConstraintEnumAny CheckCodeIssueConstraintEnum = "any" // The check will look for any code issues regardless of issue name. - CheckCodeIssueConstraintEnumContains CheckCodeIssueConstraintEnum = "contains" // The check will look for any code issues by name containing the issue name. - CheckCodeIssueConstraintEnumExact CheckCodeIssueConstraintEnum = "exact" // The check will look for any code issues matching the issue name exactly. + CheckCodeIssueConstraintEnumAny CheckCodeIssueConstraintEnum = "any" // The check will look for any code issues regardless of issue name + CheckCodeIssueConstraintEnumContains CheckCodeIssueConstraintEnum = "contains" // The check will look for any code issues by name containing the issue name + CheckCodeIssueConstraintEnumExact CheckCodeIssueConstraintEnum = "exact" // The check will look for any code issues matching the issue name exactly ) // All CheckCodeIssueConstraintEnum as []string @@ -254,12 +253,12 @@ var AllCheckCodeIssueConstraintEnum = []string{ string(CheckCodeIssueConstraintEnumExact), } -// CheckResultStatusEnum represents the status of the check result. +// CheckResultStatusEnum The status of the check result type CheckResultStatusEnum string var ( - CheckResultStatusEnumFailed CheckResultStatusEnum = "failed" // Indicates that the check has failed for the associated service. - CheckResultStatusEnumPassed CheckResultStatusEnum = "passed" // Indicates that the check has passed for the associated service.. + CheckResultStatusEnumFailed CheckResultStatusEnum = "failed" // Indicates that the check has failed for the associated service + CheckResultStatusEnumPassed CheckResultStatusEnum = "passed" // Indicates that the check has passed for the associated service. ) // All CheckResultStatusEnum as []string @@ -268,13 +267,13 @@ var AllCheckResultStatusEnum = []string{ string(CheckResultStatusEnumPassed), } -// CheckStatus represents the evaluation status of the check. +// CheckStatus The evaluation status of the check type CheckStatus string var ( - CheckStatusFailed CheckStatus = "failed" // The check evaluated to a falsy value based on some conditions. - CheckStatusPassed CheckStatus = "passed" // The check evaluated to a truthy value based on some conditions. - CheckStatusPending CheckStatus = "pending" // The check has not been evaluated yet.. + CheckStatusFailed CheckStatus = "failed" // The check evaluated to a falsy value based on some conditions + CheckStatusPassed CheckStatus = "passed" // The check evaluated to a truthy value based on some conditions + CheckStatusPending CheckStatus = "pending" // The check has not been evaluated yet. ) // All CheckStatus as []string @@ -284,30 +283,30 @@ var AllCheckStatus = []string{ string(CheckStatusPending), } -// CheckType represents the type of check. +// CheckType The type of check type CheckType string var ( - CheckTypeAlertSourceUsage CheckType = "alert_source_usage" // Verifies that the service has an alert source of a particular type or name. - CheckTypeCodeIssue CheckType = "code_issue" // Verifies that the severity and quantity of code issues does not exceed defined thresholds. - CheckTypeCustom CheckType = "custom" // Allows for the creation of programmatic checks that use an API to mark the status as passing or failing. - CheckTypeGeneric CheckType = "generic" // Requires a generic integration api call to complete a series of checks for multiple services. - CheckTypeGitBranchProtection CheckType = "git_branch_protection" // Verifies that all the repositories on the service have branch protection enabled. - CheckTypeHasDocumentation CheckType = "has_documentation" // Verifies that the service has visible documentation of a particular type and subtype. - CheckTypeHasOwner CheckType = "has_owner" // Verifies that the service has an owner defined. - CheckTypeHasRecentDeploy CheckType = "has_recent_deploy" // Verifies that the services has received a deploy within a specified number of days. - CheckTypeHasRepository CheckType = "has_repository" // Verifies that the service has a repository integrated. - CheckTypeHasServiceConfig CheckType = "has_service_config" // Verifies that the service is maintained though the use of an opslevel.yml service config. - CheckTypeManual CheckType = "manual" // Requires a service owner to manually complete a check for the service. - CheckTypePackageVersion CheckType = "package_version" // Verifies certain aspects of a service using or not using software packages. - CheckTypePayload CheckType = "payload" // Requires a payload integration api call to complete a check for the service. - CheckTypeRepoFile CheckType = "repo_file" // Quickly scan the service’s repository for the existence or contents of a specific file. - CheckTypeRepoGrep CheckType = "repo_grep" // Run a comprehensive search across the service's repository using advanced search parameters. - CheckTypeRepoSearch CheckType = "repo_search" // Quickly search the service’s repository for specific contents in any file. - CheckTypeServiceDependency CheckType = "service_dependency" // Verifies that the service has either a dependent or dependency. - CheckTypeServiceProperty CheckType = "service_property" // Verifies that a service property is set or matches a specified format. - CheckTypeTagDefined CheckType = "tag_defined" // Verifies that the service has the specified tag defined. - CheckTypeToolUsage CheckType = "tool_usage" // Verifies that the service is using a tool of a particular category or name. + CheckTypeAlertSourceUsage CheckType = "alert_source_usage" // Verifies that the service has an alert source of a particular type or name + CheckTypeCodeIssue CheckType = "code_issue" // Verifies that the severity and quantity of code issues does not exceed defined thresholds + CheckTypeCustom CheckType = "custom" // Allows for the creation of programmatic checks that use an API to mark the status as passing or failing + CheckTypeGeneric CheckType = "generic" // Requires a generic integration api call to complete a series of checks for multiple services + CheckTypeGitBranchProtection CheckType = "git_branch_protection" // Verifies that all the repositories on the service have branch protection enabled + CheckTypeHasDocumentation CheckType = "has_documentation" // Verifies that the service has visible documentation of a particular type and subtype + CheckTypeHasOwner CheckType = "has_owner" // Verifies that the service has an owner defined + CheckTypeHasRecentDeploy CheckType = "has_recent_deploy" // Verifies that the services has received a deploy within a specified number of days + CheckTypeHasRepository CheckType = "has_repository" // Verifies that the service has a repository integrated + CheckTypeHasServiceConfig CheckType = "has_service_config" // Verifies that the service is maintained though the use of an opslevel.yml service config + CheckTypeManual CheckType = "manual" // Requires a service owner to manually complete a check for the service + CheckTypePackageVersion CheckType = "package_version" // Verifies certain aspects of a service using or not using software packages + CheckTypePayload CheckType = "payload" // Requires a payload integration api call to complete a check for the service + CheckTypeRepoFile CheckType = "repo_file" // Quickly scan the service’s repository for the existence or contents of a specific file + CheckTypeRepoGrep CheckType = "repo_grep" // Run a comprehensive search across the service's repository using advanced search parameters + CheckTypeRepoSearch CheckType = "repo_search" // Quickly search the service’s repository for specific contents in any file + CheckTypeServiceDependency CheckType = "service_dependency" // Verifies that the service has either a dependent or dependency + CheckTypeServiceProperty CheckType = "service_property" // Verifies that a service property is set or matches a specified format + CheckTypeTagDefined CheckType = "tag_defined" // Verifies that the service has the specified tag defined + CheckTypeToolUsage CheckType = "tool_usage" // Verifies that the service is using a tool of a particular category or name ) // All CheckType as []string @@ -334,13 +333,13 @@ var AllCheckType = []string{ string(CheckTypeToolUsage), } -// CodeIssueResolutionTimeUnitEnum represents the allowed values for duration units for the resolution time. +// CodeIssueResolutionTimeUnitEnum The allowed values for duration units for the resolution time type CodeIssueResolutionTimeUnitEnum string var ( - CodeIssueResolutionTimeUnitEnumDay CodeIssueResolutionTimeUnitEnum = "day" // Day, as a duration. - CodeIssueResolutionTimeUnitEnumMonth CodeIssueResolutionTimeUnitEnum = "month" // Month, as a duration. - CodeIssueResolutionTimeUnitEnumWeek CodeIssueResolutionTimeUnitEnum = "week" // Week, as a duration. + CodeIssueResolutionTimeUnitEnumDay CodeIssueResolutionTimeUnitEnum = "day" // Day, as a duration + CodeIssueResolutionTimeUnitEnumMonth CodeIssueResolutionTimeUnitEnum = "month" // Month, as a duration + CodeIssueResolutionTimeUnitEnumWeek CodeIssueResolutionTimeUnitEnum = "week" // Week, as a duration ) // All CodeIssueResolutionTimeUnitEnum as []string @@ -350,12 +349,12 @@ var AllCodeIssueResolutionTimeUnitEnum = []string{ string(CodeIssueResolutionTimeUnitEnumWeek), } -// ConnectiveEnum represents the logical operator to be used in conjunction with multiple filters (requires filters to be supplied). +// ConnectiveEnum The logical operator to be used in conjunction with multiple filters (requires filters to be supplied) type ConnectiveEnum string var ( - ConnectiveEnumAnd ConnectiveEnum = "and" // Used to ensure **all** filters match for a given resource. - ConnectiveEnumOr ConnectiveEnum = "or" // Used to ensure **any** filters match for a given resource. + ConnectiveEnumAnd ConnectiveEnum = "and" // Used to ensure **all** filters match for a given resource + ConnectiveEnumOr ConnectiveEnum = "or" // Used to ensure **any** filters match for a given resource ) // All ConnectiveEnum as []string @@ -364,16 +363,16 @@ var AllConnectiveEnum = []string{ string(ConnectiveEnumOr), } -// ContactType represents the method of contact. +// ContactType The method of contact type ContactType string var ( - ContactTypeEmail ContactType = "email" // An email contact method. - ContactTypeGitHub ContactType = "github" // A GitHub handle. - ContactTypeMicrosoftTeams ContactType = "microsoft_teams" // A Microsoft Teams channel. - ContactTypeSlack ContactType = "slack" // A Slack channel contact method. - ContactTypeSlackHandle ContactType = "slack_handle" // A Slack handle contact method. - ContactTypeWeb ContactType = "web" // A website contact method. + ContactTypeEmail ContactType = "email" // An email contact method + ContactTypeGitHub ContactType = "github" // A GitHub handle + ContactTypeMicrosoftTeams ContactType = "microsoft_teams" // A Microsoft Teams channel + ContactTypeSlack ContactType = "slack" // A Slack channel contact method + ContactTypeSlackHandle ContactType = "slack_handle" // A Slack handle contact method + ContactTypeWeb ContactType = "web" // A website contact method ) // All ContactType as []string @@ -386,12 +385,12 @@ var AllContactType = []string{ string(ContactTypeWeb), } -// CustomActionsEntityTypeEnum represents the entity types a custom action can be associated with. +// CustomActionsEntityTypeEnum The entity types a custom action can be associated with type CustomActionsEntityTypeEnum string var ( - CustomActionsEntityTypeEnumGlobal CustomActionsEntityTypeEnum = "GLOBAL" // A custom action associated with the global scope (no particular entity type). - CustomActionsEntityTypeEnumService CustomActionsEntityTypeEnum = "SERVICE" // A custom action associated with services. + CustomActionsEntityTypeEnumGlobal CustomActionsEntityTypeEnum = "GLOBAL" // A custom action associated with the global scope (no particular entity type) + CustomActionsEntityTypeEnumService CustomActionsEntityTypeEnum = "SERVICE" // A custom action associated with services ) // All CustomActionsEntityTypeEnum as []string @@ -400,15 +399,15 @@ var AllCustomActionsEntityTypeEnum = []string{ string(CustomActionsEntityTypeEnumService), } -// CustomActionsHttpMethodEnum represents an HTTP request method. +// CustomActionsHttpMethodEnum An HTTP request method type CustomActionsHttpMethodEnum string var ( - CustomActionsHttpMethodEnumDelete CustomActionsHttpMethodEnum = "DELETE" // An HTTP DELETE request. - CustomActionsHttpMethodEnumGet CustomActionsHttpMethodEnum = "GET" // An HTTP GET request. - CustomActionsHttpMethodEnumPatch CustomActionsHttpMethodEnum = "PATCH" // An HTTP PATCH request. - CustomActionsHttpMethodEnumPost CustomActionsHttpMethodEnum = "POST" // An HTTP POST request. - CustomActionsHttpMethodEnumPut CustomActionsHttpMethodEnum = "PUT" // An HTTP PUT request. + CustomActionsHttpMethodEnumDelete CustomActionsHttpMethodEnum = "DELETE" // An HTTP DELETE request + CustomActionsHttpMethodEnumGet CustomActionsHttpMethodEnum = "GET" // An HTTP GET request + CustomActionsHttpMethodEnumPatch CustomActionsHttpMethodEnum = "PATCH" // An HTTP PATCH request + CustomActionsHttpMethodEnumPost CustomActionsHttpMethodEnum = "POST" // An HTTP POST request + CustomActionsHttpMethodEnumPut CustomActionsHttpMethodEnum = "PUT" // An HTTP PUT request ) // All CustomActionsHttpMethodEnum as []string @@ -420,13 +419,13 @@ var AllCustomActionsHttpMethodEnum = []string{ string(CustomActionsHttpMethodEnumPut), } -// CustomActionsTriggerDefinitionAccessControlEnum represents who can see and use the trigger definition. +// CustomActionsTriggerDefinitionAccessControlEnum Who can see and use the trigger definition type CustomActionsTriggerDefinitionAccessControlEnum string var ( - CustomActionsTriggerDefinitionAccessControlEnumAdmins CustomActionsTriggerDefinitionAccessControlEnum = "admins" // Admin users. - CustomActionsTriggerDefinitionAccessControlEnumEveryone CustomActionsTriggerDefinitionAccessControlEnum = "everyone" // All users of OpsLevel. - CustomActionsTriggerDefinitionAccessControlEnumServiceOwners CustomActionsTriggerDefinitionAccessControlEnum = "service_owners" // The owners of a service. + CustomActionsTriggerDefinitionAccessControlEnumAdmins CustomActionsTriggerDefinitionAccessControlEnum = "admins" // Admin users + CustomActionsTriggerDefinitionAccessControlEnumEveryone CustomActionsTriggerDefinitionAccessControlEnum = "everyone" // All users of OpsLevel + CustomActionsTriggerDefinitionAccessControlEnumServiceOwners CustomActionsTriggerDefinitionAccessControlEnum = "service_owners" // The owners of a service ) // All CustomActionsTriggerDefinitionAccessControlEnum as []string @@ -436,13 +435,13 @@ var AllCustomActionsTriggerDefinitionAccessControlEnum = []string{ string(CustomActionsTriggerDefinitionAccessControlEnumServiceOwners), } -// CustomActionsTriggerEventStatusEnum represents the status of the custom action trigger event. +// CustomActionsTriggerEventStatusEnum The status of the custom action trigger event type CustomActionsTriggerEventStatusEnum string var ( - CustomActionsTriggerEventStatusEnumFailure CustomActionsTriggerEventStatusEnum = "FAILURE" // The action failed to complete. - CustomActionsTriggerEventStatusEnumPending CustomActionsTriggerEventStatusEnum = "PENDING" // A result has not been determined. - CustomActionsTriggerEventStatusEnumSuccess CustomActionsTriggerEventStatusEnum = "SUCCESS" // The action completed successfully. + CustomActionsTriggerEventStatusEnumFailure CustomActionsTriggerEventStatusEnum = "FAILURE" // The action failed to complete + CustomActionsTriggerEventStatusEnumPending CustomActionsTriggerEventStatusEnum = "PENDING" // A result has not been determined + CustomActionsTriggerEventStatusEnumSuccess CustomActionsTriggerEventStatusEnum = "SUCCESS" // The action completed successfully ) // All CustomActionsTriggerEventStatusEnum as []string @@ -452,17 +451,17 @@ var AllCustomActionsTriggerEventStatusEnum = []string{ string(CustomActionsTriggerEventStatusEnumSuccess), } -// DayOfWeekEnum represents possible days of the week. +// DayOfWeekEnum Possible days of the week type DayOfWeekEnum string var ( - DayOfWeekEnumFriday DayOfWeekEnum = "friday" // Yesterday was Thursday. Tomorrow is Saturday. We so excited. - DayOfWeekEnumMonday DayOfWeekEnum = "monday" // Monday is the day of the week that takes place between Sunday and Tuesday. - DayOfWeekEnumSaturday DayOfWeekEnum = "saturday" // The day of the week before Sunday and following Friday, and (together with Sunday) forming part of the weekend. - DayOfWeekEnumSunday DayOfWeekEnum = "sunday" // The day of the week before Monday and following Saturday, (together with Saturday) forming part of the weekend. - DayOfWeekEnumThursday DayOfWeekEnum = "thursday" // The day of the week before Friday and following Wednesday. - DayOfWeekEnumTuesday DayOfWeekEnum = "tuesday" // Tuesday is the day of the week between Monday and Wednesday. - DayOfWeekEnumWednesday DayOfWeekEnum = "wednesday" // The day of the week before Thursday and following Tuesday. + DayOfWeekEnumFriday DayOfWeekEnum = "friday" // Yesterday was Thursday. Tomorrow is Saturday. We so excited + DayOfWeekEnumMonday DayOfWeekEnum = "monday" // Monday is the day of the week that takes place between Sunday and Tuesday + DayOfWeekEnumSaturday DayOfWeekEnum = "saturday" // The day of the week before Sunday and following Friday, and (together with Sunday) forming part of the weekend + DayOfWeekEnumSunday DayOfWeekEnum = "sunday" // The day of the week before Monday and following Saturday, (together with Saturday) forming part of the weekend + DayOfWeekEnumThursday DayOfWeekEnum = "thursday" // The day of the week before Friday and following Wednesday + DayOfWeekEnumTuesday DayOfWeekEnum = "tuesday" // Tuesday is the day of the week between Monday and Wednesday + DayOfWeekEnumWednesday DayOfWeekEnum = "wednesday" // The day of the week before Thursday and following Tuesday ) // All DayOfWeekEnum as []string @@ -476,41 +475,41 @@ var AllDayOfWeekEnum = []string{ string(DayOfWeekEnumWednesday), } -// EventIntegrationEnum represents the type of event integration. +// EventIntegrationEnum The type of event integration type EventIntegrationEnum string var ( - EventIntegrationEnumApidoc EventIntegrationEnum = "apiDoc" // API Documentation integration. - EventIntegrationEnumAquasecurity EventIntegrationEnum = "aquaSecurity" // Aqua Security Custom Event Check integration. - EventIntegrationEnumArgocd EventIntegrationEnum = "argocd" // ArgoCD deploy integration. - EventIntegrationEnumAwsecr EventIntegrationEnum = "awsEcr" // AWS ECR Custom Event Check integration. - EventIntegrationEnumBugsnag EventIntegrationEnum = "bugsnag" // Bugsnag Custom Event Check integration. - EventIntegrationEnumCircleci EventIntegrationEnum = "circleci" // CircleCI deploy integration. - EventIntegrationEnumCodacy EventIntegrationEnum = "codacy" // Codacy Custom Event Check integration. - EventIntegrationEnumCoveralls EventIntegrationEnum = "coveralls" // Coveralls Custom Event Check integration. - EventIntegrationEnumCustomevent EventIntegrationEnum = "customEvent" // Custom Event integration. - EventIntegrationEnumDatadogcheck EventIntegrationEnum = "datadogCheck" // Datadog Check integration. - EventIntegrationEnumDeploy EventIntegrationEnum = "deploy" // Deploy integration. - EventIntegrationEnumDynatrace EventIntegrationEnum = "dynatrace" // Dynatrace Custom Event Check integration. - EventIntegrationEnumFlux EventIntegrationEnum = "flux" // Flux deploy integration. - EventIntegrationEnumGithubactions EventIntegrationEnum = "githubActions" // Github Actions deploy integration. - EventIntegrationEnumGitlabci EventIntegrationEnum = "gitlabCi" // Gitlab CI deploy integration. - EventIntegrationEnumGrafana EventIntegrationEnum = "grafana" // Grafana Custom Event Check integration. - EventIntegrationEnumGrype EventIntegrationEnum = "grype" // Grype Custom Event Check integration. - EventIntegrationEnumJenkins EventIntegrationEnum = "jenkins" // Jenkins deploy integration. - EventIntegrationEnumJfrogxray EventIntegrationEnum = "jfrogXray" // JFrog Xray Custom Event Check integration. - EventIntegrationEnumLacework EventIntegrationEnum = "lacework" // Lacework Custom Event Check integration. - EventIntegrationEnumNewreliccheck EventIntegrationEnum = "newRelicCheck" // New Relic Check integration. - EventIntegrationEnumOctopus EventIntegrationEnum = "octopus" // Octopus deploy integration. - EventIntegrationEnumPrismacloud EventIntegrationEnum = "prismaCloud" // Prisma Cloud Custom Event Check integration. - EventIntegrationEnumPrometheus EventIntegrationEnum = "prometheus" // Prometheus Custom Event Check integration. - EventIntegrationEnumRollbar EventIntegrationEnum = "rollbar" // Rollbar Custom Event Check integration. - EventIntegrationEnumSentry EventIntegrationEnum = "sentry" // Sentry Custom Event Check integration. - EventIntegrationEnumSnyk EventIntegrationEnum = "snyk" // Snyk Custom Event Check integration. - EventIntegrationEnumSonarqube EventIntegrationEnum = "sonarqube" // SonarQube Custom Event Check integration. - EventIntegrationEnumStackhawk EventIntegrationEnum = "stackhawk" // StackHawk Custom Event Check integration. - EventIntegrationEnumSumologic EventIntegrationEnum = "sumoLogic" // Sumo Logic Custom Event Check integration. - EventIntegrationEnumVeracode EventIntegrationEnum = "veracode" // Veracode Custom Event Check integration. + EventIntegrationEnumApidoc EventIntegrationEnum = "apiDoc" // API Documentation integration + EventIntegrationEnumAquasecurity EventIntegrationEnum = "aquaSecurity" // Aqua Security Custom Event Check integration + EventIntegrationEnumArgocd EventIntegrationEnum = "argocd" // ArgoCD deploy integration + EventIntegrationEnumAwsecr EventIntegrationEnum = "awsEcr" // AWS ECR Custom Event Check integration + EventIntegrationEnumBugsnag EventIntegrationEnum = "bugsnag" // Bugsnag Custom Event Check integration + EventIntegrationEnumCircleci EventIntegrationEnum = "circleci" // CircleCI deploy integration + EventIntegrationEnumCodacy EventIntegrationEnum = "codacy" // Codacy Custom Event Check integration + EventIntegrationEnumCoveralls EventIntegrationEnum = "coveralls" // Coveralls Custom Event Check integration + EventIntegrationEnumCustomevent EventIntegrationEnum = "customEvent" // Custom Event integration + EventIntegrationEnumDatadogcheck EventIntegrationEnum = "datadogCheck" // Datadog Check integration + EventIntegrationEnumDeploy EventIntegrationEnum = "deploy" // Deploy integration + EventIntegrationEnumDynatrace EventIntegrationEnum = "dynatrace" // Dynatrace Custom Event Check integration + EventIntegrationEnumFlux EventIntegrationEnum = "flux" // Flux deploy integration + EventIntegrationEnumGithubactions EventIntegrationEnum = "githubActions" // Github Actions deploy integration + EventIntegrationEnumGitlabci EventIntegrationEnum = "gitlabCi" // Gitlab CI deploy integration + EventIntegrationEnumGrafana EventIntegrationEnum = "grafana" // Grafana Custom Event Check integration + EventIntegrationEnumGrype EventIntegrationEnum = "grype" // Grype Custom Event Check integration + EventIntegrationEnumJenkins EventIntegrationEnum = "jenkins" // Jenkins deploy integration + EventIntegrationEnumJfrogxray EventIntegrationEnum = "jfrogXray" // JFrog Xray Custom Event Check integration + EventIntegrationEnumLacework EventIntegrationEnum = "lacework" // Lacework Custom Event Check integration + EventIntegrationEnumNewreliccheck EventIntegrationEnum = "newRelicCheck" // New Relic Check integration + EventIntegrationEnumOctopus EventIntegrationEnum = "octopus" // Octopus deploy integration + EventIntegrationEnumPrismacloud EventIntegrationEnum = "prismaCloud" // Prisma Cloud Custom Event Check integration + EventIntegrationEnumPrometheus EventIntegrationEnum = "prometheus" // Prometheus Custom Event Check integration + EventIntegrationEnumRollbar EventIntegrationEnum = "rollbar" // Rollbar Custom Event Check integration + EventIntegrationEnumSentry EventIntegrationEnum = "sentry" // Sentry Custom Event Check integration + EventIntegrationEnumSnyk EventIntegrationEnum = "snyk" // Snyk Custom Event Check integration + EventIntegrationEnumSonarqube EventIntegrationEnum = "sonarqube" // SonarQube Custom Event Check integration + EventIntegrationEnumStackhawk EventIntegrationEnum = "stackhawk" // StackHawk Custom Event Check integration + EventIntegrationEnumSumologic EventIntegrationEnum = "sumoLogic" // Sumo Logic Custom Event Check integration + EventIntegrationEnumVeracode EventIntegrationEnum = "veracode" // Veracode Custom Event Check integration ) // All EventIntegrationEnum as []string @@ -548,14 +547,14 @@ var AllEventIntegrationEnum = []string{ string(EventIntegrationEnumVeracode), } -// FrequencyTimeScale represents the time scale type for the frequency. +// FrequencyTimeScale The time scale type for the frequency type FrequencyTimeScale string var ( - FrequencyTimeScaleDay FrequencyTimeScale = "day" // Consider the time scale of days. - FrequencyTimeScaleMonth FrequencyTimeScale = "month" // Consider the time scale of months. - FrequencyTimeScaleWeek FrequencyTimeScale = "week" // Consider the time scale of weeks. - FrequencyTimeScaleYear FrequencyTimeScale = "year" // Consider the time scale of years. + FrequencyTimeScaleDay FrequencyTimeScale = "day" // Consider the time scale of days + FrequencyTimeScaleMonth FrequencyTimeScale = "month" // Consider the time scale of months + FrequencyTimeScaleWeek FrequencyTimeScale = "week" // Consider the time scale of weeks + FrequencyTimeScaleYear FrequencyTimeScale = "year" // Consider the time scale of years ) // All FrequencyTimeScale as []string @@ -566,24 +565,22 @@ var AllFrequencyTimeScale = []string{ string(FrequencyTimeScaleYear), } -// HasDocumentationSubtypeEnum represents the subtype of the document. +// HasDocumentationSubtypeEnum The subtype of the document type HasDocumentationSubtypeEnum string -var ( - HasDocumentationSubtypeEnumOpenapi HasDocumentationSubtypeEnum = "openapi" // Document is an OpenAPI document. -) +var HasDocumentationSubtypeEnumOpenapi HasDocumentationSubtypeEnum = "openapi" // Document is an OpenAPI document // All HasDocumentationSubtypeEnum as []string var AllHasDocumentationSubtypeEnum = []string{ string(HasDocumentationSubtypeEnumOpenapi), } -// HasDocumentationTypeEnum represents the type of the document. +// HasDocumentationTypeEnum The type of the document type HasDocumentationTypeEnum string var ( - HasDocumentationTypeEnumAPI HasDocumentationTypeEnum = "api" // Document is an API document. - HasDocumentationTypeEnumTech HasDocumentationTypeEnum = "tech" // Document is a Tech document. + HasDocumentationTypeEnumAPI HasDocumentationTypeEnum = "api" // Document is an API document + HasDocumentationTypeEnumTech HasDocumentationTypeEnum = "tech" // Document is a Tech document ) // All HasDocumentationTypeEnum as []string @@ -592,13 +589,13 @@ var AllHasDocumentationTypeEnum = []string{ string(HasDocumentationTypeEnumTech), } -// PackageConstraintEnum represents possible values of a package version check constraint. +// PackageConstraintEnum Possible values of a package version check constraint type PackageConstraintEnum string var ( - PackageConstraintEnumDoesNotExist PackageConstraintEnum = "does_not_exist" // The package must not be used by a service. - PackageConstraintEnumExists PackageConstraintEnum = "exists" // The package must be used by a service. - PackageConstraintEnumMatchesVersion PackageConstraintEnum = "matches_version" // The package usage by a service must match certain specified version constraints. + PackageConstraintEnumDoesNotExist PackageConstraintEnum = "does_not_exist" // The package must not be used by a service + PackageConstraintEnumExists PackageConstraintEnum = "exists" // The package must be used by a service + PackageConstraintEnumMatchesVersion PackageConstraintEnum = "matches_version" // The package usage by a service must match certain specified version constraints ) // All PackageConstraintEnum as []string @@ -608,42 +605,42 @@ var AllPackageConstraintEnum = []string{ string(PackageConstraintEnumMatchesVersion), } -// PackageManagerEnum represents supported software package manager types. +// PackageManagerEnum Supported software package manager types type PackageManagerEnum string var ( - PackageManagerEnumAlpm PackageManagerEnum = "alpm" // . - PackageManagerEnumApk PackageManagerEnum = "apk" // . - PackageManagerEnumBitbucket PackageManagerEnum = "bitbucket" // . - PackageManagerEnumBitnami PackageManagerEnum = "bitnami" // . - PackageManagerEnumCargo PackageManagerEnum = "cargo" // . - PackageManagerEnumCocoapods PackageManagerEnum = "cocoapods" // . - PackageManagerEnumComposer PackageManagerEnum = "composer" // . - PackageManagerEnumConan PackageManagerEnum = "conan" // . - PackageManagerEnumConda PackageManagerEnum = "conda" // . - PackageManagerEnumCpan PackageManagerEnum = "cpan" // . - PackageManagerEnumCran PackageManagerEnum = "cran" // . - PackageManagerEnumDeb PackageManagerEnum = "deb" // . - PackageManagerEnumDocker PackageManagerEnum = "docker" // . - PackageManagerEnumGem PackageManagerEnum = "gem" // . - PackageManagerEnumGeneric PackageManagerEnum = "generic" // . - PackageManagerEnumGitHub PackageManagerEnum = "github" // . - PackageManagerEnumGolang PackageManagerEnum = "golang" // . - PackageManagerEnumGradle PackageManagerEnum = "gradle" // . - PackageManagerEnumHackage PackageManagerEnum = "hackage" // . - PackageManagerEnumHelm PackageManagerEnum = "helm" // . - PackageManagerEnumHex PackageManagerEnum = "hex" // . - PackageManagerEnumMaven PackageManagerEnum = "maven" // . - PackageManagerEnumMlflow PackageManagerEnum = "mlflow" // . - PackageManagerEnumNpm PackageManagerEnum = "npm" // . - PackageManagerEnumNuget PackageManagerEnum = "nuget" // . - PackageManagerEnumOci PackageManagerEnum = "oci" // . - PackageManagerEnumPub PackageManagerEnum = "pub" // . - PackageManagerEnumPypi PackageManagerEnum = "pypi" // . - PackageManagerEnumQpkg PackageManagerEnum = "qpkg" // . - PackageManagerEnumRpm PackageManagerEnum = "rpm" // . - PackageManagerEnumSwid PackageManagerEnum = "swid" // . - PackageManagerEnumSwift PackageManagerEnum = "swift" // . + PackageManagerEnumAlpm PackageManagerEnum = "alpm" // + PackageManagerEnumApk PackageManagerEnum = "apk" // + PackageManagerEnumBitbucket PackageManagerEnum = "bitbucket" // + PackageManagerEnumBitnami PackageManagerEnum = "bitnami" // + PackageManagerEnumCargo PackageManagerEnum = "cargo" // + PackageManagerEnumCocoapods PackageManagerEnum = "cocoapods" // + PackageManagerEnumComposer PackageManagerEnum = "composer" // + PackageManagerEnumConan PackageManagerEnum = "conan" // + PackageManagerEnumConda PackageManagerEnum = "conda" // + PackageManagerEnumCpan PackageManagerEnum = "cpan" // + PackageManagerEnumCran PackageManagerEnum = "cran" // + PackageManagerEnumDeb PackageManagerEnum = "deb" // + PackageManagerEnumDocker PackageManagerEnum = "docker" // + PackageManagerEnumGem PackageManagerEnum = "gem" // + PackageManagerEnumGeneric PackageManagerEnum = "generic" // + PackageManagerEnumGitHub PackageManagerEnum = "github" // + PackageManagerEnumGolang PackageManagerEnum = "golang" // + PackageManagerEnumGradle PackageManagerEnum = "gradle" // + PackageManagerEnumHackage PackageManagerEnum = "hackage" // + PackageManagerEnumHelm PackageManagerEnum = "helm" // + PackageManagerEnumHex PackageManagerEnum = "hex" // + PackageManagerEnumMaven PackageManagerEnum = "maven" // + PackageManagerEnumMlflow PackageManagerEnum = "mlflow" // + PackageManagerEnumNpm PackageManagerEnum = "npm" // + PackageManagerEnumNuget PackageManagerEnum = "nuget" // + PackageManagerEnumOci PackageManagerEnum = "oci" // + PackageManagerEnumPub PackageManagerEnum = "pub" // + PackageManagerEnumPypi PackageManagerEnum = "pypi" // + PackageManagerEnumQpkg PackageManagerEnum = "qpkg" // + PackageManagerEnumRpm PackageManagerEnum = "rpm" // + PackageManagerEnumSwid PackageManagerEnum = "swid" // + PackageManagerEnumSwift PackageManagerEnum = "swift" // ) // All PackageManagerEnum as []string @@ -682,26 +679,24 @@ var AllPackageManagerEnum = []string{ string(PackageManagerEnumSwift), } -// PayloadFilterEnum represents fields that can be used as part of filters for payloads. +// PayloadFilterEnum Fields that can be used as part of filters for payloads type PayloadFilterEnum string -var ( - PayloadFilterEnumIntegrationID PayloadFilterEnum = "integration_id" // Filter by `integration` field. Note that this is an internal id, ex. "123". -) +var PayloadFilterEnumIntegrationID PayloadFilterEnum = "integration_id" // Filter by `integration` field. Note that this is an internal id, ex. "123" // All PayloadFilterEnum as []string var AllPayloadFilterEnum = []string{ string(PayloadFilterEnumIntegrationID), } -// PayloadSortEnum represents sort possibilities for payloads. +// PayloadSortEnum Sort possibilities for payloads type PayloadSortEnum string var ( - PayloadSortEnumCreatedAtAsc PayloadSortEnum = "created_at_ASC" // Order by `created_at` ascending. - PayloadSortEnumCreatedAtDesc PayloadSortEnum = "created_at_DESC" // Order by `created_at` descending. - PayloadSortEnumProcessedAtAsc PayloadSortEnum = "processed_at_ASC" // Order by `processed_at` ascending. - PayloadSortEnumProcessedAtDesc PayloadSortEnum = "processed_at_DESC" // Order by `processed_at` descending. + PayloadSortEnumCreatedAtAsc PayloadSortEnum = "created_at_ASC" // Order by `created_at` ascending + PayloadSortEnumCreatedAtDesc PayloadSortEnum = "created_at_DESC" // Order by `created_at` descending + PayloadSortEnumProcessedAtAsc PayloadSortEnum = "processed_at_ASC" // Order by `processed_at` ascending + PayloadSortEnumProcessedAtDesc PayloadSortEnum = "processed_at_DESC" // Order by `processed_at` descending ) // All PayloadSortEnum as []string @@ -712,27 +707,27 @@ var AllPayloadSortEnum = []string{ string(PayloadSortEnumProcessedAtDesc), } -// PredicateKeyEnum represents fields that can be used as part of filter for services. +// PredicateKeyEnum Fields that can be used as part of filter for services type PredicateKeyEnum string var ( - PredicateKeyEnumAliases PredicateKeyEnum = "aliases" // Filter by Alias attached to this service, if any. - PredicateKeyEnumCreationSource PredicateKeyEnum = "creation_source" // Filter by the creation source. - PredicateKeyEnumDomainID PredicateKeyEnum = "domain_id" // Filter by Domain that includes the System this service is assigned to, if any. - PredicateKeyEnumFilterID PredicateKeyEnum = "filter_id" // Filter by another filter. - PredicateKeyEnumFramework PredicateKeyEnum = "framework" // Filter by `framework` field. - PredicateKeyEnumGroupIDs PredicateKeyEnum = "group_ids" // Filter by group hierarchy. Will return resources who's owner is in the group ancestry chain. - PredicateKeyEnumLanguage PredicateKeyEnum = "language" // Filter by `language` field. - PredicateKeyEnumLifecycleIndex PredicateKeyEnum = "lifecycle_index" // Filter by `lifecycle` field. - PredicateKeyEnumName PredicateKeyEnum = "name" // Filter by `name` field. - PredicateKeyEnumOwnerID PredicateKeyEnum = "owner_id" // Filter by `owner` field. - PredicateKeyEnumOwnerIDs PredicateKeyEnum = "owner_ids" // Filter by `owner` hierarchy. Will return resources who's owner is in the team ancestry chain. - PredicateKeyEnumProduct PredicateKeyEnum = "product" // Filter by `product` field. - PredicateKeyEnumProperties PredicateKeyEnum = "properties" // Filter by custom-defined properties. - PredicateKeyEnumRepositoryIDs PredicateKeyEnum = "repository_ids" // Filter by Repository that this service is attached to, if any. - PredicateKeyEnumSystemID PredicateKeyEnum = "system_id" // Filter by System that this service is assigned to, if any. - PredicateKeyEnumTags PredicateKeyEnum = "tags" // Filter by `tags` field. - PredicateKeyEnumTierIndex PredicateKeyEnum = "tier_index" // Filter by `tier` field. + PredicateKeyEnumAliases PredicateKeyEnum = "aliases" // Filter by Alias attached to this service, if any + PredicateKeyEnumCreationSource PredicateKeyEnum = "creation_source" // Filter by the creation source + PredicateKeyEnumDomainID PredicateKeyEnum = "domain_id" // Filter by Domain that includes the System this service is assigned to, if any + PredicateKeyEnumFilterID PredicateKeyEnum = "filter_id" // Filter by another filter + PredicateKeyEnumFramework PredicateKeyEnum = "framework" // Filter by `framework` field + PredicateKeyEnumGroupIDs PredicateKeyEnum = "group_ids" // Filter by group hierarchy. Will return resources who's owner is in the group ancestry chain + PredicateKeyEnumLanguage PredicateKeyEnum = "language" // Filter by `language` field + PredicateKeyEnumLifecycleIndex PredicateKeyEnum = "lifecycle_index" // Filter by `lifecycle` field + PredicateKeyEnumName PredicateKeyEnum = "name" // Filter by `name` field + PredicateKeyEnumOwnerID PredicateKeyEnum = "owner_id" // Filter by `owner` field + PredicateKeyEnumOwnerIDs PredicateKeyEnum = "owner_ids" // Filter by `owner` hierarchy. Will return resources who's owner is in the team ancestry chain + PredicateKeyEnumProduct PredicateKeyEnum = "product" // Filter by `product` field + PredicateKeyEnumProperties PredicateKeyEnum = "properties" // Filter by custom-defined properties + PredicateKeyEnumRepositoryIDs PredicateKeyEnum = "repository_ids" // Filter by Repository that this service is attached to, if any + PredicateKeyEnumSystemID PredicateKeyEnum = "system_id" // Filter by System that this service is assigned to, if any + PredicateKeyEnumTags PredicateKeyEnum = "tags" // Filter by `tags` field + PredicateKeyEnumTierIndex PredicateKeyEnum = "tier_index" // Filter by `tier` field ) // All PredicateKeyEnum as []string @@ -756,27 +751,27 @@ var AllPredicateKeyEnum = []string{ string(PredicateKeyEnumTierIndex), } -// PredicateTypeEnum represents operations that can be used on predicates. +// PredicateTypeEnum Operations that can be used on predicates type PredicateTypeEnum string var ( - PredicateTypeEnumBelongsTo PredicateTypeEnum = "belongs_to" // Belongs to a group's hierarchy. - PredicateTypeEnumContains PredicateTypeEnum = "contains" // Contains a specific value. - PredicateTypeEnumDoesNotContain PredicateTypeEnum = "does_not_contain" // Does not contain a specific value. - PredicateTypeEnumDoesNotEqual PredicateTypeEnum = "does_not_equal" // Does not equal a specific value. - PredicateTypeEnumDoesNotExist PredicateTypeEnum = "does_not_exist" // Specific attribute does not exist. - PredicateTypeEnumDoesNotMatch PredicateTypeEnum = "does_not_match" // A certain filter is not matched. - PredicateTypeEnumDoesNotMatchRegex PredicateTypeEnum = "does_not_match_regex" // Does not match a value using a regular expression. - PredicateTypeEnumEndsWith PredicateTypeEnum = "ends_with" // Ends with a specific value. - PredicateTypeEnumEquals PredicateTypeEnum = "equals" // Equals a specific value. - PredicateTypeEnumExists PredicateTypeEnum = "exists" // Specific attribute exists. - PredicateTypeEnumGreaterThanOrEqualTo PredicateTypeEnum = "greater_than_or_equal_to" // Greater than or equal to a specific value (numeric only). - PredicateTypeEnumLessThanOrEqualTo PredicateTypeEnum = "less_than_or_equal_to" // Less than or equal to a specific value (numeric only). - PredicateTypeEnumMatches PredicateTypeEnum = "matches" // A certain filter is matched. - PredicateTypeEnumMatchesRegex PredicateTypeEnum = "matches_regex" // Matches a value using a regular expression. - PredicateTypeEnumSatisfiesJqExpression PredicateTypeEnum = "satisfies_jq_expression" // Satisfies an expression defined in jq. - PredicateTypeEnumSatisfiesVersionConstraint PredicateTypeEnum = "satisfies_version_constraint" // Satisfies version constraint (tag value only). - PredicateTypeEnumStartsWith PredicateTypeEnum = "starts_with" // Starts with a specific value. + PredicateTypeEnumBelongsTo PredicateTypeEnum = "belongs_to" // Belongs to a group's hierarchy + PredicateTypeEnumContains PredicateTypeEnum = "contains" // Contains a specific value + PredicateTypeEnumDoesNotContain PredicateTypeEnum = "does_not_contain" // Does not contain a specific value + PredicateTypeEnumDoesNotEqual PredicateTypeEnum = "does_not_equal" // Does not equal a specific value + PredicateTypeEnumDoesNotExist PredicateTypeEnum = "does_not_exist" // Specific attribute does not exist + PredicateTypeEnumDoesNotMatch PredicateTypeEnum = "does_not_match" // A certain filter is not matched + PredicateTypeEnumDoesNotMatchRegex PredicateTypeEnum = "does_not_match_regex" // Does not match a value using a regular expression + PredicateTypeEnumEndsWith PredicateTypeEnum = "ends_with" // Ends with a specific value + PredicateTypeEnumEquals PredicateTypeEnum = "equals" // Equals a specific value + PredicateTypeEnumExists PredicateTypeEnum = "exists" // Specific attribute exists + PredicateTypeEnumGreaterThanOrEqualTo PredicateTypeEnum = "greater_than_or_equal_to" // Greater than or equal to a specific value (numeric only) + PredicateTypeEnumLessThanOrEqualTo PredicateTypeEnum = "less_than_or_equal_to" // Less than or equal to a specific value (numeric only) + PredicateTypeEnumMatches PredicateTypeEnum = "matches" // A certain filter is matched + PredicateTypeEnumMatchesRegex PredicateTypeEnum = "matches_regex" // Matches a value using a regular expression + PredicateTypeEnumSatisfiesJqExpression PredicateTypeEnum = "satisfies_jq_expression" // Satisfies an expression defined in jq + PredicateTypeEnumSatisfiesVersionConstraint PredicateTypeEnum = "satisfies_version_constraint" // Satisfies version constraint (tag value only) + PredicateTypeEnumStartsWith PredicateTypeEnum = "starts_with" // Starts with a specific value ) // All PredicateTypeEnum as []string @@ -800,16 +795,16 @@ var AllPredicateTypeEnum = []string{ string(PredicateTypeEnumStartsWith), } -// PropertyDefinitionDisplayTypeEnum represents the set of possible display types of a property definition schema. +// PropertyDefinitionDisplayTypeEnum The set of possible display types of a property definition schema type PropertyDefinitionDisplayTypeEnum string var ( - PropertyDefinitionDisplayTypeEnumArray PropertyDefinitionDisplayTypeEnum = "ARRAY" // An array. - PropertyDefinitionDisplayTypeEnumBoolean PropertyDefinitionDisplayTypeEnum = "BOOLEAN" // A boolean. - PropertyDefinitionDisplayTypeEnumDropdown PropertyDefinitionDisplayTypeEnum = "DROPDOWN" // A dropdown. - PropertyDefinitionDisplayTypeEnumNumber PropertyDefinitionDisplayTypeEnum = "NUMBER" // A number. - PropertyDefinitionDisplayTypeEnumObject PropertyDefinitionDisplayTypeEnum = "OBJECT" // An object. - PropertyDefinitionDisplayTypeEnumText PropertyDefinitionDisplayTypeEnum = "TEXT" // A text string. + PropertyDefinitionDisplayTypeEnumArray PropertyDefinitionDisplayTypeEnum = "ARRAY" // An array + PropertyDefinitionDisplayTypeEnumBoolean PropertyDefinitionDisplayTypeEnum = "BOOLEAN" // A boolean + PropertyDefinitionDisplayTypeEnumDropdown PropertyDefinitionDisplayTypeEnum = "DROPDOWN" // A dropdown + PropertyDefinitionDisplayTypeEnumNumber PropertyDefinitionDisplayTypeEnum = "NUMBER" // A number + PropertyDefinitionDisplayTypeEnumObject PropertyDefinitionDisplayTypeEnum = "OBJECT" // An object + PropertyDefinitionDisplayTypeEnumText PropertyDefinitionDisplayTypeEnum = "TEXT" // A text string ) // All PropertyDefinitionDisplayTypeEnum as []string @@ -822,12 +817,12 @@ var AllPropertyDefinitionDisplayTypeEnum = []string{ string(PropertyDefinitionDisplayTypeEnumText), } -// PropertyDisplayStatusEnum represents the display status of a custom property on service pages. +// PropertyDisplayStatusEnum The display status of a custom property on service pages type PropertyDisplayStatusEnum string var ( - PropertyDisplayStatusEnumHidden PropertyDisplayStatusEnum = "hidden" // The property is not shown on the service page. - PropertyDisplayStatusEnumVisible PropertyDisplayStatusEnum = "visible" // The property is shown on the service page. + PropertyDisplayStatusEnumHidden PropertyDisplayStatusEnum = "hidden" // The property is not shown on the service page + PropertyDisplayStatusEnumVisible PropertyDisplayStatusEnum = "visible" // The property is shown on the service page ) // All PropertyDisplayStatusEnum as []string @@ -836,15 +831,15 @@ var AllPropertyDisplayStatusEnum = []string{ string(PropertyDisplayStatusEnumVisible), } -// RelatedResourceRelationshipTypeEnum represents the type of the relationship between two resources. +// RelatedResourceRelationshipTypeEnum The type of the relationship between two resources type RelatedResourceRelationshipTypeEnum string var ( - RelatedResourceRelationshipTypeEnumBelongsTo RelatedResourceRelationshipTypeEnum = "belongs_to" // The resource belongs to the node on the edge. - RelatedResourceRelationshipTypeEnumContains RelatedResourceRelationshipTypeEnum = "contains" // The resource contains the node on the edge. - RelatedResourceRelationshipTypeEnumDependencyOf RelatedResourceRelationshipTypeEnum = "dependency_of" // The resource is a dependency of the node on the edge. - RelatedResourceRelationshipTypeEnumDependsOn RelatedResourceRelationshipTypeEnum = "depends_on" // The resource depends on the node on the edge. - RelatedResourceRelationshipTypeEnumMemberOf RelatedResourceRelationshipTypeEnum = "member_of" // The resource is a member of the node on the edge. + RelatedResourceRelationshipTypeEnumBelongsTo RelatedResourceRelationshipTypeEnum = "belongs_to" // The resource belongs to the node on the edge + RelatedResourceRelationshipTypeEnumContains RelatedResourceRelationshipTypeEnum = "contains" // The resource contains the node on the edge + RelatedResourceRelationshipTypeEnumDependencyOf RelatedResourceRelationshipTypeEnum = "dependency_of" // The resource is a dependency of the node on the edge + RelatedResourceRelationshipTypeEnumDependsOn RelatedResourceRelationshipTypeEnum = "depends_on" // The resource depends on the node on the edge + RelatedResourceRelationshipTypeEnumMemberOf RelatedResourceRelationshipTypeEnum = "member_of" // The resource is a member of the node on the edge ) // All RelatedResourceRelationshipTypeEnum as []string @@ -856,12 +851,12 @@ var AllRelatedResourceRelationshipTypeEnum = []string{ string(RelatedResourceRelationshipTypeEnumMemberOf), } -// RelationshipTypeEnum represents the type of relationship between two resources. +// RelationshipTypeEnum The type of relationship between two resources type RelationshipTypeEnum string var ( - RelationshipTypeEnumBelongsTo RelationshipTypeEnum = "belongs_to" // The source resource belongs to the target resource. - RelationshipTypeEnumDependsOn RelationshipTypeEnum = "depends_on" // The source resource depends on the target resource. + RelationshipTypeEnumBelongsTo RelationshipTypeEnum = "belongs_to" // The source resource belongs to the target resource + RelationshipTypeEnumDependsOn RelationshipTypeEnum = "depends_on" // The source resource depends on the target resource ) // All RelationshipTypeEnum as []string @@ -870,14 +865,14 @@ var AllRelationshipTypeEnum = []string{ string(RelationshipTypeEnumDependsOn), } -// RepositoryVisibilityEnum represents possible visibility levels for repositories. +// RepositoryVisibilityEnum Possible visibility levels for repositories type RepositoryVisibilityEnum string var ( - RepositoryVisibilityEnumInternal RepositoryVisibilityEnum = "INTERNAL" // Repositories that are only accessible to organization users (Github, Gitlab). - RepositoryVisibilityEnumOrganization RepositoryVisibilityEnum = "ORGANIZATION" // Repositories that are only accessible to organization users (ADO). - RepositoryVisibilityEnumPrivate RepositoryVisibilityEnum = "PRIVATE" // Repositories that are private to the user. - RepositoryVisibilityEnumPublic RepositoryVisibilityEnum = "PUBLIC" // Repositories that are publicly accessible. + RepositoryVisibilityEnumInternal RepositoryVisibilityEnum = "INTERNAL" // Repositories that are only accessible to organization users (Github, Gitlab) + RepositoryVisibilityEnumOrganization RepositoryVisibilityEnum = "ORGANIZATION" // Repositories that are only accessible to organization users (ADO) + RepositoryVisibilityEnumPrivate RepositoryVisibilityEnum = "PRIVATE" // Repositories that are private to the user + RepositoryVisibilityEnumPublic RepositoryVisibilityEnum = "PUBLIC" // Repositories that are publicly accessible ) // All RepositoryVisibilityEnum as []string @@ -888,13 +883,13 @@ var AllRepositoryVisibilityEnum = []string{ string(RepositoryVisibilityEnumPublic), } -// ResourceDocumentStatusTypeEnum represents status of a document on a resource. +// ResourceDocumentStatusTypeEnum Status of a document on a resource type ResourceDocumentStatusTypeEnum string var ( - ResourceDocumentStatusTypeEnumHidden ResourceDocumentStatusTypeEnum = "hidden" // Document is hidden. - ResourceDocumentStatusTypeEnumPinned ResourceDocumentStatusTypeEnum = "pinned" // Document is pinned. - ResourceDocumentStatusTypeEnumVisible ResourceDocumentStatusTypeEnum = "visible" // Document is visible. + ResourceDocumentStatusTypeEnumHidden ResourceDocumentStatusTypeEnum = "hidden" // Document is hidden + ResourceDocumentStatusTypeEnumPinned ResourceDocumentStatusTypeEnum = "pinned" // Document is pinned + ResourceDocumentStatusTypeEnumVisible ResourceDocumentStatusTypeEnum = "visible" // Document is visible ) // All ResourceDocumentStatusTypeEnum as []string @@ -904,22 +899,22 @@ var AllResourceDocumentStatusTypeEnum = []string{ string(ResourceDocumentStatusTypeEnumVisible), } -// ScorecardSortEnum represents the possible options to sort the resulting list of scorecards. +// ScorecardSortEnum The possible options to sort the resulting list of scorecards type ScorecardSortEnum string var ( - ScorecardSortEnumAffectsoverallservicelevelsAsc ScorecardSortEnum = "affectsOverallServiceLevels_ASC" // Order by whether or not the checks on the scorecard affect the overall maturity, in ascending order. - ScorecardSortEnumAffectsoverallservicelevelsDesc ScorecardSortEnum = "affectsOverallServiceLevels_DESC" // Order by whether or not the checks on the scorecard affect the overall maturity, in descending order. - ScorecardSortEnumFilterAsc ScorecardSortEnum = "filter_ASC" // Order by the associated filter's name, in ascending order. - ScorecardSortEnumFilterDesc ScorecardSortEnum = "filter_DESC" // Order by the associated filter's name, in descending order. - ScorecardSortEnumNameAsc ScorecardSortEnum = "name_ASC" // Order by the scorecard's name, in ascending order. - ScorecardSortEnumNameDesc ScorecardSortEnum = "name_DESC" // Order by the scorecard's name, in descending order. - ScorecardSortEnumOwnerAsc ScorecardSortEnum = "owner_ASC" // Order by the scorecard owner's name, in ascending order. - ScorecardSortEnumOwnerDesc ScorecardSortEnum = "owner_DESC" // Order by the scorecard owner's name, in descending order. - ScorecardSortEnumPassingcheckfractionAsc ScorecardSortEnum = "passingCheckFraction_ASC" // Order by the fraction of passing checks on the scorecard, in ascending order. - ScorecardSortEnumPassingcheckfractionDesc ScorecardSortEnum = "passingCheckFraction_DESC" // Order by the fraction of passing checks on the scorecard, in descending order. - ScorecardSortEnumServicecountAsc ScorecardSortEnum = "serviceCount_ASC" // Order by the number of services covered by the scorecard, in ascending order. - ScorecardSortEnumServicecountDesc ScorecardSortEnum = "serviceCount_DESC" // Order by the number of services covered by the scorecard, in descending order. + ScorecardSortEnumAffectsoverallservicelevelsAsc ScorecardSortEnum = "affectsOverallServiceLevels_ASC" // Order by whether or not the checks on the scorecard affect the overall maturity, in ascending order + ScorecardSortEnumAffectsoverallservicelevelsDesc ScorecardSortEnum = "affectsOverallServiceLevels_DESC" // Order by whether or not the checks on the scorecard affect the overall maturity, in descending order + ScorecardSortEnumFilterAsc ScorecardSortEnum = "filter_ASC" // Order by the associated filter's name, in ascending order + ScorecardSortEnumFilterDesc ScorecardSortEnum = "filter_DESC" // Order by the associated filter's name, in descending order + ScorecardSortEnumNameAsc ScorecardSortEnum = "name_ASC" // Order by the scorecard's name, in ascending order + ScorecardSortEnumNameDesc ScorecardSortEnum = "name_DESC" // Order by the scorecard's name, in descending order + ScorecardSortEnumOwnerAsc ScorecardSortEnum = "owner_ASC" // Order by the scorecard owner's name, in ascending order + ScorecardSortEnumOwnerDesc ScorecardSortEnum = "owner_DESC" // Order by the scorecard owner's name, in descending order + ScorecardSortEnumPassingcheckfractionAsc ScorecardSortEnum = "passingCheckFraction_ASC" // Order by the fraction of passing checks on the scorecard, in ascending order + ScorecardSortEnumPassingcheckfractionDesc ScorecardSortEnum = "passingCheckFraction_DESC" // Order by the fraction of passing checks on the scorecard, in descending order + ScorecardSortEnumServicecountAsc ScorecardSortEnum = "serviceCount_ASC" // Order by the number of services covered by the scorecard, in ascending order + ScorecardSortEnumServicecountDesc ScorecardSortEnum = "serviceCount_DESC" // Order by the number of services covered by the scorecard, in descending order ) // All ScorecardSortEnum as []string @@ -938,20 +933,20 @@ var AllScorecardSortEnum = []string{ string(ScorecardSortEnumServicecountDesc), } -// ServicePropertyTypeEnum represents properties of services that can be validated. +// ServicePropertyTypeEnum Properties of services that can be validated type ServicePropertyTypeEnum string var ( - ServicePropertyTypeEnumCustomProperty ServicePropertyTypeEnum = "custom_property" // A custom property that is associated with the service. - ServicePropertyTypeEnumDescription ServicePropertyTypeEnum = "description" // The description of a service. - ServicePropertyTypeEnumFramework ServicePropertyTypeEnum = "framework" // The primary software development framework of a service. - ServicePropertyTypeEnumLanguage ServicePropertyTypeEnum = "language" // The primary programming language of a service. - ServicePropertyTypeEnumLifecycleIndex ServicePropertyTypeEnum = "lifecycle_index" // The index of the lifecycle a service belongs to. - ServicePropertyTypeEnumName ServicePropertyTypeEnum = "name" // The name of a service. - ServicePropertyTypeEnumNote ServicePropertyTypeEnum = "note" // Additional information about the service. - ServicePropertyTypeEnumProduct ServicePropertyTypeEnum = "product" // The product that is associated with a service. - ServicePropertyTypeEnumSystem ServicePropertyTypeEnum = "system" // The system that the service belongs to. - ServicePropertyTypeEnumTierIndex ServicePropertyTypeEnum = "tier_index" // The index of the tier a service belongs to. + ServicePropertyTypeEnumCustomProperty ServicePropertyTypeEnum = "custom_property" // A custom property that is associated with the service + ServicePropertyTypeEnumDescription ServicePropertyTypeEnum = "description" // The description of a service + ServicePropertyTypeEnumFramework ServicePropertyTypeEnum = "framework" // The primary software development framework of a service + ServicePropertyTypeEnumLanguage ServicePropertyTypeEnum = "language" // The primary programming language of a service + ServicePropertyTypeEnumLifecycleIndex ServicePropertyTypeEnum = "lifecycle_index" // The index of the lifecycle a service belongs to + ServicePropertyTypeEnumName ServicePropertyTypeEnum = "name" // The name of a service + ServicePropertyTypeEnumNote ServicePropertyTypeEnum = "note" // Additional information about the service + ServicePropertyTypeEnumProduct ServicePropertyTypeEnum = "product" // The product that is associated with a service + ServicePropertyTypeEnumSystem ServicePropertyTypeEnum = "system" // The system that the service belongs to + ServicePropertyTypeEnumTierIndex ServicePropertyTypeEnum = "tier_index" // The index of the tier a service belongs to ) // All ServicePropertyTypeEnum as []string @@ -968,32 +963,32 @@ var AllServicePropertyTypeEnum = []string{ string(ServicePropertyTypeEnumTierIndex), } -// ServiceSortEnum represents sort possibilities for services. +// ServiceSortEnum Sort possibilities for services type ServiceSortEnum string var ( - ServiceSortEnumAlertStatusAsc ServiceSortEnum = "alert_status_ASC" // Sort by alert status ascending. - ServiceSortEnumAlertStatusDesc ServiceSortEnum = "alert_status_DESC" // Sort by alert status descending. - ServiceSortEnumChecksPassingAsc ServiceSortEnum = "checks_passing_ASC" // Sort by `checks_passing` ascending. - ServiceSortEnumChecksPassingDesc ServiceSortEnum = "checks_passing_DESC" // Sort by `checks_passing` descending. - ServiceSortEnumComponentTypeAsc ServiceSortEnum = "component_type_ASC" // Sort by component type ascending. - ServiceSortEnumComponentTypeDesc ServiceSortEnum = "component_type_DESC" // Sort by component type descending. - ServiceSortEnumLastDeployAsc ServiceSortEnum = "last_deploy_ASC" // Sort by last deploy time ascending. - ServiceSortEnumLastDeployDesc ServiceSortEnum = "last_deploy_DESC" // Sort by last deploy time descending. - ServiceSortEnumLevelIndexAsc ServiceSortEnum = "level_index_ASC" // Sort by level ascending. - ServiceSortEnumLevelIndexDesc ServiceSortEnum = "level_index_DESC" // Sort by level descending. - ServiceSortEnumLifecycleAsc ServiceSortEnum = "lifecycle_ASC" // Sort by lifecycle ascending. - ServiceSortEnumLifecycleDesc ServiceSortEnum = "lifecycle_DESC" // Sort by lifecycle descending. - ServiceSortEnumNameAsc ServiceSortEnum = "name_ASC" // Sort by `name` ascending. - ServiceSortEnumNameDesc ServiceSortEnum = "name_DESC" // Sort by `name` descending. - ServiceSortEnumOwnerAsc ServiceSortEnum = "owner_ASC" // Sort by `owner` ascending. - ServiceSortEnumOwnerDesc ServiceSortEnum = "owner_DESC" // Sort by `owner` descending. - ServiceSortEnumProductAsc ServiceSortEnum = "product_ASC" // Sort by `product` ascending. - ServiceSortEnumProductDesc ServiceSortEnum = "product_DESC" // Sort by `product` descending. - ServiceSortEnumServiceStatAsc ServiceSortEnum = "service_stat_ASC" // Alias to sort by `checks_passing` ascending. - ServiceSortEnumServiceStatDesc ServiceSortEnum = "service_stat_DESC" // Alias to sort by `checks_passing` descending. - ServiceSortEnumTierAsc ServiceSortEnum = "tier_ASC" // Sort by `tier` ascending. - ServiceSortEnumTierDesc ServiceSortEnum = "tier_DESC" // Sort by `tier` descending. + ServiceSortEnumAlertStatusAsc ServiceSortEnum = "alert_status_ASC" // Sort by alert status ascending + ServiceSortEnumAlertStatusDesc ServiceSortEnum = "alert_status_DESC" // Sort by alert status descending + ServiceSortEnumChecksPassingAsc ServiceSortEnum = "checks_passing_ASC" // Sort by `checks_passing` ascending + ServiceSortEnumChecksPassingDesc ServiceSortEnum = "checks_passing_DESC" // Sort by `checks_passing` descending + ServiceSortEnumComponentTypeAsc ServiceSortEnum = "component_type_ASC" // Sort by component type ascending + ServiceSortEnumComponentTypeDesc ServiceSortEnum = "component_type_DESC" // Sort by component type descending + ServiceSortEnumLastDeployAsc ServiceSortEnum = "last_deploy_ASC" // Sort by last deploy time ascending + ServiceSortEnumLastDeployDesc ServiceSortEnum = "last_deploy_DESC" // Sort by last deploy time descending + ServiceSortEnumLevelIndexAsc ServiceSortEnum = "level_index_ASC" // Sort by level ascending + ServiceSortEnumLevelIndexDesc ServiceSortEnum = "level_index_DESC" // Sort by level descending + ServiceSortEnumLifecycleAsc ServiceSortEnum = "lifecycle_ASC" // Sort by lifecycle ascending + ServiceSortEnumLifecycleDesc ServiceSortEnum = "lifecycle_DESC" // Sort by lifecycle descending + ServiceSortEnumNameAsc ServiceSortEnum = "name_ASC" // Sort by `name` ascending + ServiceSortEnumNameDesc ServiceSortEnum = "name_DESC" // Sort by `name` descending + ServiceSortEnumOwnerAsc ServiceSortEnum = "owner_ASC" // Sort by `owner` ascending + ServiceSortEnumOwnerDesc ServiceSortEnum = "owner_DESC" // Sort by `owner` descending + ServiceSortEnumProductAsc ServiceSortEnum = "product_ASC" // Sort by `product` ascending + ServiceSortEnumProductDesc ServiceSortEnum = "product_DESC" // Sort by `product` descending + ServiceSortEnumServiceStatAsc ServiceSortEnum = "service_stat_ASC" // Alias to sort by `checks_passing` ascending + ServiceSortEnumServiceStatDesc ServiceSortEnum = "service_stat_DESC" // Alias to sort by `checks_passing` descending + ServiceSortEnumTierAsc ServiceSortEnum = "tier_ASC" // Sort by `tier` ascending + ServiceSortEnumTierDesc ServiceSortEnum = "tier_DESC" // Sort by `tier` descending ) // All ServiceSortEnum as []string @@ -1022,13 +1017,13 @@ var AllServiceSortEnum = []string{ string(ServiceSortEnumTierDesc), } -// SnykIntegrationRegionEnum represents the data residency regions offered by Snyk. +// SnykIntegrationRegionEnum The data residency regions offered by Snyk type SnykIntegrationRegionEnum string var ( - SnykIntegrationRegionEnumAu SnykIntegrationRegionEnum = "AU" // Australia (https://api.au.snyk.io). - SnykIntegrationRegionEnumEu SnykIntegrationRegionEnum = "EU" // Europe (https://api.eu.snyk.io). - SnykIntegrationRegionEnumUs SnykIntegrationRegionEnum = "US" // USA (https://app.snyk.io). + SnykIntegrationRegionEnumAu SnykIntegrationRegionEnum = "AU" // Australia (https://api.au.snyk.io) + SnykIntegrationRegionEnumEu SnykIntegrationRegionEnum = "EU" // Europe (https://api.eu.snyk.io) + SnykIntegrationRegionEnumUs SnykIntegrationRegionEnum = "US" // USA (https://app.snyk.io) ) // All SnykIntegrationRegionEnum as []string @@ -1038,17 +1033,17 @@ var AllSnykIntegrationRegionEnum = []string{ string(SnykIntegrationRegionEnumUs), } -// TaggableResource represents possible types to apply tags to. +// TaggableResource Possible types to apply tags to type TaggableResource string var ( - TaggableResourceDomain TaggableResource = "Domain" // Used to identify a Domain. - TaggableResourceInfrastructureresource TaggableResource = "InfrastructureResource" // Used to identify an Infrastructure Resource. - TaggableResourceRepository TaggableResource = "Repository" // Used to identify a Repository. - TaggableResourceService TaggableResource = "Service" // Used to identify a Service. - TaggableResourceSystem TaggableResource = "System" // Used to identify a System. - TaggableResourceTeam TaggableResource = "Team" // Used to identify a Team. - TaggableResourceUser TaggableResource = "User" // Used to identify a User. + TaggableResourceDomain TaggableResource = "Domain" // Used to identify a Domain + TaggableResourceInfrastructureresource TaggableResource = "InfrastructureResource" // Used to identify an Infrastructure Resource + TaggableResourceRepository TaggableResource = "Repository" // Used to identify a Repository + TaggableResourceService TaggableResource = "Service" // Used to identify a Service + TaggableResourceSystem TaggableResource = "System" // Used to identify a System + TaggableResourceTeam TaggableResource = "Team" // Used to identify a Team + TaggableResourceUser TaggableResource = "User" // Used to identify a User ) // All TaggableResource as []string @@ -1062,33 +1057,33 @@ var AllTaggableResource = []string{ string(TaggableResourceUser), } -// ToolCategory represents the specific categories that a tool can belong to. +// ToolCategory The specific categories that a tool can belong to type ToolCategory string var ( - ToolCategoryAdmin ToolCategory = "admin" // Tools used for administrative purposes. - ToolCategoryAPIDocumentation ToolCategory = "api_documentation" // Tools used as API documentation for this service. - ToolCategoryArchitectureDiagram ToolCategory = "architecture_diagram" // Tools used for diagramming architecture. - ToolCategoryBacklog ToolCategory = "backlog" // Tools used for tracking issues. - ToolCategoryCode ToolCategory = "code" // Tools used for source code. - ToolCategoryContinuousIntegration ToolCategory = "continuous_integration" // Tools used for building/unit testing a service. - ToolCategoryDeployment ToolCategory = "deployment" // Tools used for deploying changes to a service. - ToolCategoryDesignDocumentation ToolCategory = "design_documentation" // Tools used for documenting design. - ToolCategoryErrors ToolCategory = "errors" // Tools used for tracking/reporting errors. - ToolCategoryFeatureFlag ToolCategory = "feature_flag" // Tools used for managing feature flags. - ToolCategoryHealthChecks ToolCategory = "health_checks" // Tools used for tracking/reporting the health of a service. - ToolCategoryIncidents ToolCategory = "incidents" // Tools used to surface incidents on a service. - ToolCategoryIssueTracking ToolCategory = "issue_tracking" // Tools used for tracking issues. - ToolCategoryLogs ToolCategory = "logs" // Tools used for displaying logs from services. - ToolCategoryMetrics ToolCategory = "metrics" // Tools used for tracking/reporting service metrics. - ToolCategoryObservability ToolCategory = "observability" // Tools used for observability. - ToolCategoryOrchestrator ToolCategory = "orchestrator" // Tools used for orchestrating a service. - ToolCategoryOther ToolCategory = "other" // Tools that do not fit into the available categories. - ToolCategoryResiliency ToolCategory = "resiliency" // Tools used for testing the resiliency of a service. - ToolCategoryRunbooks ToolCategory = "runbooks" // Tools used for managing runbooks for a service. - ToolCategorySecurityScans ToolCategory = "security_scans" // Tools used for performing security scans. - ToolCategoryStatusPage ToolCategory = "status_page" // Tools used for reporting the status of a service. - ToolCategoryWiki ToolCategory = "wiki" // Tools used as a wiki for this service. + ToolCategoryAdmin ToolCategory = "admin" // Tools used for administrative purposes + ToolCategoryAPIDocumentation ToolCategory = "api_documentation" // Tools used as API documentation for this service + ToolCategoryArchitectureDiagram ToolCategory = "architecture_diagram" // Tools used for diagramming architecture + ToolCategoryBacklog ToolCategory = "backlog" // Tools used for tracking issues + ToolCategoryCode ToolCategory = "code" // Tools used for source code + ToolCategoryContinuousIntegration ToolCategory = "continuous_integration" // Tools used for building/unit testing a service + ToolCategoryDeployment ToolCategory = "deployment" // Tools used for deploying changes to a service + ToolCategoryDesignDocumentation ToolCategory = "design_documentation" // Tools used for documenting design + ToolCategoryErrors ToolCategory = "errors" // Tools used for tracking/reporting errors + ToolCategoryFeatureFlag ToolCategory = "feature_flag" // Tools used for managing feature flags + ToolCategoryHealthChecks ToolCategory = "health_checks" // Tools used for tracking/reporting the health of a service + ToolCategoryIncidents ToolCategory = "incidents" // Tools used to surface incidents on a service + ToolCategoryIssueTracking ToolCategory = "issue_tracking" // Tools used for tracking issues + ToolCategoryLogs ToolCategory = "logs" // Tools used for displaying logs from services + ToolCategoryMetrics ToolCategory = "metrics" // Tools used for tracking/reporting service metrics + ToolCategoryObservability ToolCategory = "observability" // Tools used for observability + ToolCategoryOrchestrator ToolCategory = "orchestrator" // Tools used for orchestrating a service + ToolCategoryOther ToolCategory = "other" // Tools that do not fit into the available categories + ToolCategoryResiliency ToolCategory = "resiliency" // Tools used for testing the resiliency of a service + ToolCategoryRunbooks ToolCategory = "runbooks" // Tools used for managing runbooks for a service + ToolCategorySecurityScans ToolCategory = "security_scans" // Tools used for performing security scans + ToolCategoryStatusPage ToolCategory = "status_page" // Tools used for reporting the status of a service + ToolCategoryWiki ToolCategory = "wiki" // Tools used as a wiki for this service ) // All ToolCategory as []string @@ -1118,14 +1113,14 @@ var AllToolCategory = []string{ string(ToolCategoryWiki), } -// UserRole represents a role that can be assigned to a user. +// UserRole A role that can be assigned to a user type UserRole string var ( - UserRoleAdmin UserRole = "admin" // An administrator on the account. - UserRoleStandardsAdmin UserRole = "standards_admin" // Full write access to Standards resources, including rubric, campaigns, and checks. User-level access to all other entities. - UserRoleTeamMember UserRole = "team_member" // Read access to all resources. Write access based on team membership. - UserRoleUser UserRole = "user" // A regular user on the account. + UserRoleAdmin UserRole = "admin" // An administrator on the account + UserRoleStandardsAdmin UserRole = "standards_admin" // Full write access to Standards resources, including rubric, campaigns, and checks. User-level access to all other entities + UserRoleTeamMember UserRole = "team_member" // Read access to all resources. Write access based on team membership + UserRoleUser UserRole = "user" // A regular user on the account ) // All UserRole as []string @@ -1136,16 +1131,16 @@ var AllUserRole = []string{ string(UserRoleUser), } -// UsersFilterEnum represents fields that can be used as part of filter for users. +// UsersFilterEnum Fields that can be used as part of filter for users type UsersFilterEnum string var ( - UsersFilterEnumDeactivatedAt UsersFilterEnum = "deactivated_at" // Filter by the `deactivated_at` field. - UsersFilterEnumEmail UsersFilterEnum = "email" // Filter by `email` field. - UsersFilterEnumLastSignInAt UsersFilterEnum = "last_sign_in_at" // Filter by the `last_sign_in_at` field. - UsersFilterEnumName UsersFilterEnum = "name" // Filter by `name` field. - UsersFilterEnumRole UsersFilterEnum = "role" // Filter by `role` field. (user or admin). - UsersFilterEnumTag UsersFilterEnum = "tag" // Filter by `tags` belonging to user. + UsersFilterEnumDeactivatedAt UsersFilterEnum = "deactivated_at" // Filter by the `deactivated_at` field + UsersFilterEnumEmail UsersFilterEnum = "email" // Filter by `email` field + UsersFilterEnumLastSignInAt UsersFilterEnum = "last_sign_in_at" // Filter by the `last_sign_in_at` field + UsersFilterEnumName UsersFilterEnum = "name" // Filter by `name` field + UsersFilterEnumRole UsersFilterEnum = "role" // Filter by `role` field. (user or admin) + UsersFilterEnumTag UsersFilterEnum = "tag" // Filter by `tags` belonging to user ) // All UsersFilterEnum as []string @@ -1158,26 +1153,24 @@ var AllUsersFilterEnum = []string{ string(UsersFilterEnumTag), } -// UsersInviteScopeEnum represents a classification of users to invite. +// UsersInviteScopeEnum A classification of users to invite type UsersInviteScopeEnum string -var ( - UsersInviteScopeEnumPending UsersInviteScopeEnum = "pending" // All users who have yet to log in to OpsLevel for the first time. -) +var UsersInviteScopeEnumPending UsersInviteScopeEnum = "pending" // All users who have yet to log in to OpsLevel for the first time // All UsersInviteScopeEnum as []string var AllUsersInviteScopeEnum = []string{ string(UsersInviteScopeEnumPending), } -// VaultSecretsSortEnum represents sort possibilities for secrets. +// VaultSecretsSortEnum Sort possibilities for secrets type VaultSecretsSortEnum string var ( - VaultSecretsSortEnumSlugAsc VaultSecretsSortEnum = "slug_ASC" // Sort by slug ascending. - VaultSecretsSortEnumSlugDesc VaultSecretsSortEnum = "slug_DESC" // Sort by slug descending. - VaultSecretsSortEnumUpdatedAtAsc VaultSecretsSortEnum = "updated_at_ASC" // Sort by updated_at ascending. - VaultSecretsSortEnumUpdatedAtDesc VaultSecretsSortEnum = "updated_at_DESC" // Sort by updated_at descending. + VaultSecretsSortEnumSlugAsc VaultSecretsSortEnum = "slug_ASC" // Sort by slug ascending + VaultSecretsSortEnumSlugDesc VaultSecretsSortEnum = "slug_DESC" // Sort by slug descending + VaultSecretsSortEnumUpdatedAtAsc VaultSecretsSortEnum = "updated_at_ASC" // Sort by updated_at ascending + VaultSecretsSortEnumUpdatedAtDesc VaultSecretsSortEnum = "updated_at_DESC" // Sort by updated_at descending ) // All VaultSecretsSortEnum as []string diff --git a/testdata/templates/component_type.tpl b/testdata/templates/component_type.tpl new file mode 100644 index 00000000..4e0fef2c --- /dev/null +++ b/testdata/templates/component_type.tpl @@ -0,0 +1,48 @@ +{{- define "component_type_graphql" }} +{id,aliases,description,href,icon{color,name},isDefault,name,timestamps{createdAt,updatedAt}} +{{end}} +{{- define "component_type_1_response" }} +{ + {{ template "id1" }}, + "aliases": [ + "example1" + ], + "name": "Example1", + "description": "Description", + "href": "https://app.opslevel-staging.com/catalog/domains/platformdomain", + "icon": { + "color": "#FFFFFF", + "name": "PhBird" + } +} +{{end}} +{{- define "component_type_2_response" }} +{ + {{ template "id2" }}, + "aliases": [ + "example2" + ], + "name": "Example2", + "description": "Description", + "href": "https://app.opslevel-staging.com/catalog/domains/platformdomain", + "icon": { + "color": "#FFFFFF", + "name": "PhBird" + } +} +{{end}} +{{- define "component_type_3_response" }} +{ + {{ template "id3" }}, + "aliases": [ + "example3" + ], + "name": "Example3", + "description": "Description", + "href": "https://app.opslevel-staging.com/catalog/domains/platformdomain", + "icon": { + "color": "#FFFFFF", + "name": "PhBird" + } +} +{{end}} \ No newline at end of file