Categorygithub.com/opslevel/opslevel-go/v2024
modulepackage
2024.9.18
Repository: https://github.com/opslevel/opslevel-go.git
Documentation: pkg.go.dev

# README

License Made With Go Release Issues Contributors Activity CodeCov Dependabot Go Reference

The OpsLevel Gopher

Overall

opslevel-go

Package opslevel provides an OpsLevel API client implementation.

Installation

opslevel requires Go version 1.8 or later.

go get -u github.com/opslevel/opslevel-go

Usage

Construct a client, specifying the API token. Then, you can use it to make GraphQL queries and mutations.

client := opslevel.NewGQLClient(opslevel.SetAPIToken("XXX_API_TOKEN_XXX"))
// Use client...

You can validate the client can successfully talk to the OpsLevel API.

client := opslevel.NewClient("XXX_API_TOKEN_XXX")
if err := client.Validate(); err != nil {
	panic(err)
}

Every resource (IE: service, lifecycle, tier, etc.) in OpsLevel API has a corresponding data structure in go as well as the graphql query & mutation inputs. Additionally, there are also some helper functions that use native go types like string and []string to make it easier to work with. The following are a handful of examples:

Find a service given an alias and print the owning team name:

foundService, foundServiceErr := client.GetServiceWithAlias("MyCoolService")
if foundServiceErr != nil {
	panic(foundServiceErr)
}
fmt.Println(foundService.Owner.Name)

Create a new service in OpsLevel and print the ID:

serviceCreateInput := opslevel.ServiceCreateInput{
	Name:        "MyCoolService",
	Product:     "MyProduct",
	Description: "The Coolest Service",
	Language:    "go",
}
newService, newServiceErr := client.CreateService(serviceCreateInput)
if newServiceErr != nil {
	panic(newServiceErr)
}
fmt.Println(newService.Id)

Assign the tag {"hello": "world"} to our newly created service and print all the tags currently on it:

allTagsOnThisService, assignTagsErr := client.AssignTags(newService.Id, map[string]string{"hello": "world"})
if assignTagsErr != nil {
	panic(assignTagsErr)
}
for _, tagOnService := range allTagsOnThisService {
	fmt.Printf("Tag '{%s : %s}'", tagOnService.Id, tagOnService.Value)
}

List all the tags for a service:

myService, foundServiceErr := client.GetServiceWithAlias("MyCoolService")
if foundServiceErr != nil {
	panic(foundServiceErr)
}
tags, getTagsErr := myService.GetTags(client, nil)
if getTagsErr != nil {
	panic(getTagsErr)
}
for _, tag := range tags {
	fmt.Printf("Tag '{%s : %s}'\n", tag.Key, tag.Value)
}

Build a lookup table of teams:

func GetTeams(client *opslevel.Client) (map[string]opslevel.Team, error) {
	teams := make(map[string]opslevel.Team)
	data, dataErr := client.ListTeams()
	if dataErr != nil {
		return teams, dataErr
	}
	for _, team := range data {
		teams[string(team.Alias)] = team
	}
	return teams, nil
}

Advanced Usage

The client also exposes functions Query and Mutate for doing custom query or mutations. We are running on top of this go graphql library.

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IsResourceValid runs validator.Validate on all `validate` struct tags.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewExampleOf makes a new OpsLevel resource with all `example` struct tags applied.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewJSONInput converts any json compatible type (bool, string, int, map, slice, etc.) into a valid JsonString.
No description provided by the author
No description provided by the author
No description provided by the author
NewNull returns a Nullable that will always marshal into `null`, can be used to unset fields.
NewNullableFrom returns a Nullable that will never marshal into `null`, can be used to change fields or even set them to an empty value (like "").
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SetDefaultsFor applies all `default` struct tags.
SetExamplesFor applies all `example` struct tags.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

Monitor is reporting an alert.
Monitor currently being updated.
No data received yet.
Monitor is not reporting any warnings or alerts.
Monitor is reporting a warning.
A Datadog alert source (aka monitor).
A New Relic alert source (aka service).
An Opsgenie alert source (aka service).
A PagerDuty alert source (aka service).
Aliases that are assigned to domains.
Aliases that are assigned to groups.
Aliases that are assigned to infrastructure resources.
Aliases that are assigned to scorecards.
Aliases that are assigned to services.
Aliases that are assigned to systems.
Aliases that are assigned to teams.
Use the document that was pulled by OpsLevel via a repo.
Use the document that was pushed to OpsLevel via an API Docs integration.
Does not equal a specific value.
Equals a specific value.
Filter by `id` of campaign.
Filter by campaign owner.
Filter by campaign status.
A system for sending messages to one or more recipients via telecommunications links between computers using dedicated software or a web-based service.
A cloud-based team communication platform developed by Slack Technologies.
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.
Each of the twelve named periods into which a year is divided.
A period of seven days.
Notification will be sent via email.
Notification will be sent by slack.
Service is failing one or more checks in the campaign.
Service is passing all the checks in the campaign.
Sort by number of `checks passing` ascending.
Sort by number of `checks passing` descending.
Sort by `endedDate` ascending.
Sort by `endedDate` descending.
Sort by `filter` ascending.
Sort by `filter` descending.
Sort by `name` ascending.
Sort by `name` descending.
Sort by `owner` ascending.
Sort by `owner` descending.
Sort by number of `services complete` ascending.
Sort by number of `services complete` descending.
Sort by `startDate` ascending.
Sort by `startDate` descending.
Sort by `status` ascending.
Sort by `status` descending.
Sort by `targetDate` ascending.
Sort by `targetDate` descending.
Campaign is delayed.
Campaign has been created but is not yet active.
Campaign ended.
Campaign is in progress.
Campaign has been scheduled to begin in the future.
Indicates that the check has failed for the associated service.
Indicates that the check has passed for the associated service..
The check evaluated to a falsy value based on some conditions.
The check evaluated to a truthy value based on some conditions.
The check has not been evaluated yet..
Verifies that the service has an alert source of a particular type or name.
Allows for the creation of programmatic checks that use an API to mark the status as passing or failing.
Requires a generic integration api call to complete a series of checks for multiple services.
Verifies that all the repositories on the service have branch protection enabled.
Verifies that the service has visible documentation of a particular type and subtype.
Verifies that the service has an owner defined.
Verifies that the services has received a deploy within a specified number of days.
Verifies that the service has a repository integrated.
Verifies that the service is maintained though the use of an opslevel.yml service config.
Requires a service owner to manually complete a check for the service.
Verifies certain aspects of a service using or not using software packages.
Requires a payload integration api call to complete a check for the service.
Quickly scan the service’s repository for the existence or contents of a specific file.
Run a comprehensive search across the service's repository using advanced search parameters.
Quickly search the service’s repository for specific contents in any file.
Verifies that the service has either a dependent or dependency.
Verifies that a service property is set or matches a specified format.
Verifies that the service has the specified tag defined.
Verifies that the service is using a tool of a particular category or name.
Used to ensure **all** filters match for a given resource.
Used to ensure **any** filters match for a given resource.
An email contact method.
A GitHub handle.
A Slack channel contact method.
A Slack handle contact method.
A website contact method.
A custom action associated with the global scope (no particular entity type).
A custom action associated with services.
An HTTP DELETE request.
An HTTP GET request.
An HTTP PATCH request.
An HTTP POST request.
An HTTP PUT request.
Admin users.
All users of OpsLevel.
The owners of a service.
The action failed to complete.
A result has not been determined.
The action completed succesfully.
Yesterday was Thursday.
Monday is the day of the week that takes place between Sunday and Tuesday.
The day of the week before Sunday and following Friday, and (together with Sunday) forming part of the weekend.
The day of the week before Monday and following Saturday, (together with Saturday) forming part of the weekend.
The day of the week before Friday and following Wednesday.
Tuesday is the day of the week between Monday and Wednesday.
The day of the week before Thursday and following Tuesday.
Consider the time scale of days.
Consider the time scale of months.
Consider the time scale of weeks.
Consider the time scale of years.
Document is an OpenAPI document.
Document is an API document.
Document is a Tech document.
The package must not be used by a service.
The package must be used by a service.
The package usage by a service must match certain specified version constraints.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Order by `created_at` ascending.
Order by `created_at` descending.
Order by `processed_at` ascending.
Order by `processed_at` descending.
Filter by Alias attached to this service, if any.
Filter by the creation source.
Filter by Domain that includes the System this service is assigned to, if any.
Filter by another filter.
Filter by `framework` field.
Filter by group hierarchy.
Filter by `language` field.
Filter by `lifecycle` field.
Filter by `name` field.
Filter by `owner` field.
Filter by `owner` hierarchy.
Filter by `product` field.
Filter by custom-defined properties.
Filter by Repository that this service is attached to, if any.
Filter by System that this service is assigned to, if any.
Filter by `tags` field.
Filter by `tier` field.
Belongs to a group's hierarchy.
Contains a specific value.
Does not contain a specific value.
Does not equal a specific value.
Specific attribute does not exist.
A certain filter is not matched.
Does not match a value using a regular expression.
Ends with a specific value.
Equals a specific value.
Specific attribute exists.
Greater than or equal to a specific value (numeric only).
Less than or equal to a specific value (numeric only).
A certain filter is matched.
Matches a value using a regular expression.
Satisfies an expression defined in jq.
Satisfies version constraint (tag value only).
Starts with a specific value.
An array.
A boolean.
A dropdown.
A number.
An object.
A text string.
The property is not shown on the service page.
The property is shown on the service page.
The resource belongs to the node on the edge.
The resource contains the node on the edge.
The resource is a dependency of the node on the edge.
The resource depends on the node on the edge.
The source resource belongs to the target resource.
The source resource depends on the target resource.
Repositories that are only accessible to organization users (Github, Gitlab).
Repositories that are only accessible to organization users (ADO).
Repositories that are private to the user.
Repositories that are publically accessible.
Document is hidden.
Document is pinned.
Document is visible.
Job was canceled.
Job run took too long to complete, and was marked as failed.
Job failed during execution.
A pod could not be scheduled for the job in time.
Job was not assigned to a runner for too long.
Job succeeded the execution.
translation missing: en.graphql.types.runner_job_outcome_enum.unstarted.
A finished runner job.
A created runner job, but not yet ready to be run.
A runner job ready to be run.
A runner job being run by a runner.
The runner will not actively take jobs.
The runner will process jobs.
Order by whether or not the checks on the scorecard affect the overall maturity, in ascending order.
Order by whether or not the checks on the scorecard affect the overall maturity, in descending order.
Order by the associated filter's name, in ascending order.
Order by the associated filter's name, in descending order.
Order by the scorecard's name, in ascending order.
Order by the scorecard's name, in descending order.
Order by the scorecard owner's name, in ascending order.
Order by the scorecard owner's name, in descending order.
Order by the fraction of passing checks on the scorecard, in ascending order.
Order by the fraction of passing checks on the scorecard, in descending order.
Order by the number of services covered by the scorecard, in ascending order.
Order by the number of services covered by the scorecard, in descending order.
A custom property that is associated with the service.
The description of a service.
The primary software development framework of a service.
The primary programming language of a service.
The index of the lifecycle a service belongs to.
The name of a service.
Additional information about the service.
The product that is associated with a service.
The system that the service belongs to.
The index of the tier a service belongs to.
Sort by alert status ascending.
Sort by alert status descending.
Sort by `checks_passing` ascending.
Sort by `checks_passing` descending.
Sort by last deploy time ascending.
Sort by last deploy time descending.
Sort by level ascending.
Sort by level descending.
Sort by lifecycle ascending.
Sort by lifecycle descending.
Sort by `name` ascending.
Sort by `name` descending.
Sort by `owner` ascending.
Sort by `owner` descending.
Sort by `product` ascending.
Sort by `product` descending.
Alias to sort by `checks_passing` ascending.
Alias to sort by `checks_passing` descending.
Sort by `tier` ascending.
Sort by `tier` descending.
Used to identify a Domain.
Used to identify an Infrastructure Resource.
Used to identify a Repository.
Used to identify a Service.
Used to identify a System.
Used to identify a Team.
Used to identify a User.
No description provided by the author
No description provided by the author
Tools used for administrative purposes.
Tools used as API documentation for this service.
Tools used for diagramming architecture.
Tools used for tracking issues.
Tools used for source code.
Tools used for building/unit testing a service.
Tools used for deploying changes to a service.
Tools used for documenting design.
Tools used for tracking/reporting errors.
Tools used for managing feature flags.
Tools used for tracking/reporting the health of a service.
Tools used to surface incidents on a service.
Tools used for tracking issues.
Tools used for displaying logs from services.
Tools used for tracking/reporting service metrics.
Tools used for observability.
Tools used for orchestrating a service.
Tools that do not fit into the available categories.
Tools used for testing the resiliency of a service.
Tools used for managing runbooks for a service.
Tools used for performing security scans.
Tools used for reporting the status of a service.
Tools used as a wiki for this service.
An administrator on the account.
Full write access to Standards resources, including rubric, campaigns, and checks.
Read access to all resources.
A regular user on the account.
Filter by the `deactivated_at` field.
Filter by `email` field.
Filter by the `last_sign_in_at` field.
Filter by `name` field.
Filter by `role` field.
Filter by `tags` belonging to user.
Sort by slug ascending.
Sort by slug descending.
Sort by updated_at ascending.
Sort by updated_at descending.

# Variables

All AlertSourceStatusTypeEnum as []string.
All AlertSourceTypeEnum as []string.
All AliasOwnerTypeEnum as []string.
All ApiDocumentSourceEnum as []string.
All BasicTypeEnum as []string.
All CampaignFilterEnum as []string.
All CampaignReminderChannelEnum as []string.
All CampaignReminderFrequencyUnitEnum as []string.
All CampaignReminderTypeEnum as []string.
All CampaignServiceStatusEnum as []string.
All CampaignSortEnum as []string.
All CampaignStatusEnum as []string.
All CheckResultStatusEnum as []string.
All CheckStatus as []string.
All CheckType as []string.
All ConnectiveEnum as []string.
All ContactType as []string.
All CustomActionsEntityTypeEnum as []string.
All CustomActionsHttpMethodEnum as []string.
All CustomActionsTriggerDefinitionAccessControlEnum as []string.
All CustomActionsTriggerEventStatusEnum as []string.
All DayOfWeekEnum as []string.
All FrequencyTimeScale as []string.
All HasDocumentationSubtypeEnum as []string.
All HasDocumentationTypeEnum as []string.
All PackageConstraintEnum as []string.
All PackageManagerEnum as []string.
All PayloadSortEnum as []string.
All PredicateKeyEnum as []string.
All PredicateTypeEnum as []string.
All PropertyDefinitionDisplayTypeEnum as []string.
All PropertyDisplayStatusEnum as []string.
All RelatedResourceRelationshipTypeEnum as []string.
All RelationshipTypeEnum as []string.
All RepositoryVisibilityEnum as []string.
All ResourceDocumentStatusTypeEnum as []string.
All ScorecardSortEnum as []string.
All ServicePropertyTypeEnum as []string.
All ServiceSortEnum as []string.
All TaggableResource as []string.
All ToolCategory as []string.
All UserRole as []string.
All UsersFilterEnum as []string.
All VaultSecretsSortEnum as []string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
AlertSourceExternalIdentifier specifies the input needed to find an alert source with external information.
No description provided by the author
AlertSourceServiceCreateInput specifies the input used for attaching an alert source to a service.
AlertSourceServiceDeleteInput specifies the input fields used in the `alertSourceServiceDelete` mutation.
No description provided by the author
AliasCreateInput represents the input for the `aliasCreate` mutation.
AliasDeleteInput represents the input for the `aliasDelete` mutation.
No description provided by the author
AwsIntegrationInput specifies the input fields used to create and update an AWS integration.
No description provided by the author
No description provided by the author
AzureResourcesIntegrationInput specifies the input fields used to create and update an Azure resources integration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CategoryCreateInput specifies the input fields used to create a category.
CategoryDeleteInput specifies the input fields used to delete a category.
CategoryUpdateInput specifies the input fields used to update a category.
Check represents checks allow you to monitor how your services are built and operated.
CheckAlertSourceUsageCreateInput specifies the input fields used to create an alert source usage check.
CheckAlertSourceUsageUpdateInput specifies the input fields used to update an alert source usage check.
No description provided by the author
No description provided by the author
CheckCustomEventCreateInput represents creates a custom event check.
CheckCustomEventUpdateInput specifies the input fields used to update a custom event check.
CheckDeleteInput specifies the input fields used to delete a check.
CheckGitBranchProtectionCreateInput specifies the input fields used to create a branch protection check.
CheckGitBranchProtectionUpdateInput specifies the input fields used to update a branch protection check.
CheckHasDocumentationCreateInput specifies the input fields used to create a documentation check.
CheckHasDocumentationUpdateInput specifies the input fields used to update a documentation check.
CheckHasRecentDeployCreateInput specifies the input fields used to create a recent deploys check.
CheckHasRecentDeployUpdateInput specifies the input fields used to update a has recent deploy check.
CheckManualCreateInput specifies the input fields used to create a manual check.
CheckManualUpdateInput specifies the input fields used to update a manual check.
No description provided by the author
CheckPackageVersionCreateInput represents information about the package version check to be created.
CheckPackageVersionUpdateInput represents information about the package version check to be updated.
CheckRepositoryFileCreateInput specifies the input fields used to create a repo file check.
CheckRepositoryFileUpdateInput specifies the input fields used to update a repo file check.
CheckRepositoryGrepCreateInput specifies the input fields used to create a repo grep check.
CheckRepositoryGrepUpdateInput specifies the input fields used to update a repo file check.
CheckRepositoryIntegratedCreateInput specifies the input fields used to create a repository integrated check.
CheckRepositoryIntegratedUpdateInput specifies the input fields used to update a repository integrated check.
CheckRepositorySearchCreateInput specifies the input fields used to create a repo search check.
CheckRepositorySearchUpdateInput specifies the input fields used to update a repo search check.
CheckResponsePayload encompasses CheckCreatePayload and CheckUpdatePayload into 1 struct.
ChecksCopyToCampaignInput specifies the input fields used to copy selected rubric checks to an existing campaign.
CheckServiceConfigurationCreateInput specifies the input fields used to create a configuration check.
CheckServiceConfigurationUpdateInput specifies the input fields used to update a configuration check.
CheckServiceDependencyCreateInput specifies the input fields used to create a service dependency check.
CheckServiceDependencyUpdateInput specifies the input fields used to update a service dependency check.
CheckServiceOwnershipCreateInput specifies the input fields used to create an ownership check.
CheckServiceOwnershipUpdateInput specifies the input fields used to update an ownership check.
CheckServicePropertyCreateInput specifies the input fields used to create a service property check.
CheckServicePropertyUpdateInput specifies the input fields used to update a service property check.
CheckTagDefinedCreateInput specifies the input fields used to create a tag check.
CheckTagDefinedUpdateInput specifies the input fields used to update a tag defined check.
CheckToolUsageCreateInput specifies the input fields used to create a tool usage check.
CheckToolUsageUpdateInput specifies the input fields used to update a tool usage check.
CheckToPromoteInput specifies the input fields used to promote a campaign check to the rubric.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ContactCreateInput specifies the input fields used to create a contact.
ContactDeleteInput specifies the input fields used to delete a contact.
ContactInput specifies the input fields used to create a contact.
ContactUpdateInput specifies the input fields used to update a contact.
CustomActionsExternalAction represents an external action to be triggered by a custom action.
No description provided by the author
No description provided by the author
No description provided by the author
CustomActionsTriggerDefinitionBase represents .
CustomActionsTriggerDefinitionCreateInput specifies the input fields used in the `customActionsTriggerDefinitionCreate` mutation.
No description provided by the author
CustomActionsTriggerDefinitionUpdateInput specifies the input fields used in the `customActionsTriggerDefinitionUpdate` mutation.
No description provided by the author
CustomActionsWebhookActionCreateInput specifies the input fields used in the `customActionsWebhookActionCreate` mutation.
CustomActionsWebhookActionUpdateInput represents inputs that specify the details of a Webhook Action you wish to update.
No description provided by the author
DeleteInput specifies the input fields used to delete an entity.
No description provided by the author
No description provided by the author
DomainInput specifies the input fields for a domain.
No description provided by the author
No description provided by the author
No description provided by the author
ExternalUuidMutationInput specifies the input used for modifying a resource's external UUID.
No description provided by the author
No description provided by the author
FilterCreateInput specifies the input fields used to create a filter.
No description provided by the author
No description provided by the author
FilterPredicateInput represents a condition that should be satisfied.
FilterUpdateInput specifies the input fields used to update a filter.
No description provided by the author
No description provided by the author
GoogleCloudIntegrationInput specifies the input fields used to create and update a Google Cloud integration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IdentifierInput specifies the input fields used to identify a resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InfrastructureResourceInput specifies the input fields for a infrastructure resource.
No description provided by the author
InfrastructureResourceProviderDataInput specifies the input fields for data about an infrastructure resource's provider.
No description provided by the author
No description provided by the author
InfrastructureResourceSchemaInput specifies the schema for an infrastructure resource.
Integration represents an integration is a way of extending OpsLevel functionality.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LevelCreateInput specifies the input fields used to create a level.
LevelDeleteInput specifies the input fields used to delete a level.
LevelUpdateInput specifies the input fields used to update a level.
No description provided by the author
ManualAlertSourceSync represents .
No description provided by the author
No description provided by the author
ManualCheckFrequencyInput represents defines a frequency for the check update.
ManualCheckFrequencyUpdateInput represents defines a frequency for the check update.
No description provided by the author
MemberInput represents input for specifiying members on a group.
NewRelicIntegrationAccountsInput represents .
No description provided by the author
NewRelicIntegrationInput represents .
Nullable can be used to unset a value using an OpsLevel input struct type, should always be instantiated using a constructor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PredicateInput represents a condition that should be satisfied.
PredicateUpdateInput represents a condition that should be satisfied.
Property represents a custom property value assigned to an entity.
PropertyDefinition represents the definition of a property.
No description provided by the author
No description provided by the author
PropertyDefinitionInput represents the input for defining a property.
PropertyInput represents the input for setting a property.
RelationshipDefinition represents a source, target and relationship type specifying a relationship between two resources.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RepositoryUpdateInput specifies the input fields used to update a repository.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ScorecardInput represents input used to create scorecards.
No description provided by the author
SecretInput represents arguments for secret operations.
No description provided by the author
TODO: Lifecycle, TeamId, Tier should probably be pointers.
No description provided by the author
ServiceCreateInput specifies the input fields used in the `serviceCreate` mutation.
ServiceDeleteInput specifies the input fields used in the `serviceDelete` mutation.
No description provided by the author
No description provided by the author
No description provided by the author
ServiceDependencyCreateInput specifies the input fields used for creating a service dependency.
ServiceDependencyKey represents a source, destination pair specifying a dependency between services.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NOTE: ServiceMaturityConnection is not part of GraphQL API schema.
ServiceNoteUpdateInput specifies the input fields used in the `serviceNoteUpdate` mutation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceRepositoryCreateInput specifies the input fields used in the `serviceRepositoryCreate` mutation.
No description provided by the author
ServiceRepositoryUpdateInput specifies the input fields used to update a service repository.
DEPRECATED: use ServiceUpdateInputV2.
ServiceUpdateInputV2 enables setting string fields like Description, Framework, LifecycleAlias, TierAlias to `null`.
No description provided by the author
No description provided by the author
SystemInput specifies the input fields for a system.
No description provided by the author
TagArgs represents arguments used to query with a certain tag.
TagAssignInput specifies the input fields used to assign tags.
No description provided by the author
TagCreateInput specifies the input fields used to create a tag.
No description provided by the author
TagDeleteInput specifies the input fields used to delete a tag.
TagInput specifies the basic input fields used to construct a tag.
TagUpdateInput specifies the input fields used to update a tag.
No description provided by the author
No description provided by the author
TeamCreateInput specifies the input fields used to create a team.
TeamDeleteInput specifies the input fields used to delete a team.
No description provided by the author
TeamIdConnection exists to prevent circular references on User because Team has a UserConnection.
No description provided by the author
No description provided by the author
TeamMembershipCreateInput represents input for adding members to a team.
TeamMembershipDeleteInput represents input for removing members from a team.
TeamMembershipUserInput represents input for specifying members on a team.
TeamUpdateInput specifies the input fields used to update a team.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ToolCreateInput specifies the input fields used to create a tool.
ToolDeleteInput specifies the input fields used to delete a tool.
ToolUpdateInput specifies the input fields used to update a tool.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UserIdentifierInput specifies the input fields used to identify a user.
UserInput specifies the input fields used to create and update a user.
UsersFilterInput represents the input for filtering users.

# Interfaces

No description provided by the author
No description provided by the author
NullableConstraint defines what types can be nullable - keep separated using the union operator (pipe).
ServiceUpdater exists for backwards compatability between ServiceUpdateInput and ServiceUpdateInputV2.
No description provided by the author

# Type aliases

AlertSourceStatusTypeEnum represents the monitor status level.
AlertSourceTypeEnum represents the type of the alert source.
AliasOwnerTypeEnum represents the owner type an alias is assigned to.
ApiDocumentSourceEnum represents the source used to determine the preferred API document.
BasicTypeEnum represents operations that can be used on filters.
CampaignFilterEnum represents fields that can be used as part of filter for campaigns.
CampaignReminderChannelEnum represents the possible communication channels through which a campaign reminder can be delivered.
CampaignReminderFrequencyUnitEnum represents possible time units for the frequency at which campaign reminders are delivered.
CampaignReminderTypeEnum represents type/Format of the notification.
CampaignServiceStatusEnum represents status of whether a service is passing all checks for a campaign or not.
CampaignSortEnum represents sort possibilities for campaigns.
CampaignStatusEnum represents the campaign status.
No description provided by the author
CheckResultStatusEnum represents the status of the check result.
CheckStatus represents the evaluation status of the check.
CheckType represents the type of check.
ConnectiveEnum represents the logical operator to be used in conjunction with multiple filters (requires filters to be supplied).
ContactType represents the method of contact.
CustomActionsEntityTypeEnum represents the entity types a custom action can be associated with.
CustomActionsHttpMethodEnum represents an HTTP request method.
CustomActionsTriggerDefinitionAccessControlEnum represents who can see and use the trigger definition.
CustomActionsTriggerEventStatusEnum represents the status of the custom action trigger event.
DayOfWeekEnum represents possible days of the week.
No description provided by the author
FrequencyTimeScale represents the time scale type for the frequency.
HasDocumentationSubtypeEnum represents the subtype of the document.
HasDocumentationTypeEnum represents the type of the document.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PackageConstraintEnum represents possible values of a package version check constraint.
PackageManagerEnum represents supported software package manager types.
PayloadSortEnum represents sort possibilities for payloads.
No description provided by the author
PredicateKeyEnum represents fields that can be used as part of filter for services.
PredicateTypeEnum represents operations that can be used on predicates.
PropertyDefinitionDisplayTypeEnum represents the set of possible display types of a property definition schema.
PropertyDisplayStatusEnum represents the display status of a custom property on service pages.
RelatedResourceRelationshipTypeEnum represents the type of the relationship between two resources.
RelationshipTypeEnum represents the type of relationship between two resources.
RepositoryVisibilityEnum represents possible visibility levels for repositories.
ResourceDocumentStatusTypeEnum represents status of a document on a resource.
RunnerJobOutcomeEnum represents the runner job outcome.
RunnerJobStatusEnum represents the runner job status.
RunnerStatusTypeEnum represents The status of an OpsLevel runner.
ScorecardSortEnum represents the possible options to sort the resulting list of scorecards.
ServicePropertyTypeEnum represents properties of services that can be validated.
ServiceSortEnum represents sort possibilities for services.
No description provided by the author
TaggableResource represents possible types to apply tags to.
No description provided by the author
ToolCategory represents the specific categories that a tool can belong to.
UserRole represents a role that can be assigned to a user.
UsersFilterEnum represents fields that can be used as part of filter for users.
VaultSecretsSortEnum represents sort possibilities for secrets.