-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathinput.go
1220 lines (1094 loc) · 156 KB
/
input.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by gen.go; DO NOT EDIT.
package opslevel
import "github.com/relvacode/iso8601"
// AlertSourceExternalIdentifier specifies the input needed to find an alert source with external information.
type AlertSourceExternalIdentifier struct {
ExternalId string `json:"externalId" yaml:"externalId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The external id of the alert. (Required.)
Type AlertSourceTypeEnum `json:"type" yaml:"type" example:"datadog"` // The type of the alert. (Required.)
}
// AlertSourceServiceCreateInput specifies the input used for attaching an alert source to a service.
type AlertSourceServiceCreateInput struct {
AlertSourceExternalIdentifier *AlertSourceExternalIdentifier `json:"alertSourceExternalIdentifier,omitempty" yaml:"alertSourceExternalIdentifier,omitempty"` // Specifies the input needed to find an alert source with external information. (Optional.)
AlertSourceId *Nullable[ID] `json:"alertSourceId,omitempty" yaml:"alertSourceId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Specifies the input needed to find an alert source with external information. (Optional.)
Service IdentifierInput `json:"service" yaml:"service"` // The service that the alert source will be attached to. (Required.)
}
// AlertSourceServiceDeleteInput specifies the input fields used in the `alertSourceServiceDelete` mutation.
type AlertSourceServiceDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the alert source service to be deleted. (Required.)
}
// AliasCreateInput represents the input for the `aliasCreate` mutation.
type AliasCreateInput struct {
Alias string `json:"alias" yaml:"alias" example:"example_value"` // The alias you wish to create. (Required.)
OwnerId ID `json:"ownerId" yaml:"ownerId" example:"example_value"` // The ID of the resource you want to create the alias on. Services, teams, groups, systems, and domains are supported. (Required.)
}
// AliasDeleteInput represents the input for the `aliasDelete` mutation.
type AliasDeleteInput struct {
Alias string `json:"alias" yaml:"alias" example:"example_value"` // The alias you wish to delete. (Required.)
OwnerType AliasOwnerTypeEnum `json:"ownerType" yaml:"ownerType" example:"domain"` // The resource the alias you wish to delete belongs to. (Required.)
}
// AwsIntegrationInput specifies the input fields used to create and update an AWS integration.
type AwsIntegrationInput struct {
AwsTagsOverrideOwnership *Nullable[bool] `json:"awsTagsOverrideOwnership,omitempty" yaml:"awsTagsOverrideOwnership,omitempty" example:"false"` // Allow tags imported from AWS to override ownership set in OpsLevel directly. (Optional.)
ExternalId *Nullable[string] `json:"externalId,omitempty" yaml:"externalId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The External ID defined in the trust relationship to ensure OpsLevel is the only third party assuming this role (See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html for more details). (Optional.)
IamRole *Nullable[string] `json:"iamRole,omitempty" yaml:"iamRole,omitempty" example:"example_value"` // The IAM role OpsLevel uses in order to access the AWS account. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration. (Optional.)
OwnershipTagKeys *Nullable[[]string] `json:"ownershipTagKeys,omitempty" yaml:"ownershipTagKeys,omitempty" example:"['tag_key1', 'tag_key2']"` // An array of tag keys used to associate ownership from an integration. Max 5. (Optional.)
RegionOverride *Nullable[[]string] `json:"regionOverride,omitempty" yaml:"regionOverride,omitempty" example:"['us-east-1', 'eu-west-1']"` // Overrides the AWS region(s) that will be synchronized by this integration. (Optional.)
}
// AzureResourcesIntegrationInput specifies the input fields used to create and update an Azure resources integration.
type AzureResourcesIntegrationInput struct {
ClientId *Nullable[string] `json:"clientId,omitempty" yaml:"clientId,omitempty" example:"example_value"` // The client OpsLevel uses to access the Azure account. (Optional.)
ClientSecret *Nullable[string] `json:"clientSecret,omitempty" yaml:"clientSecret,omitempty" example:"example_value"` // The client secret OpsLevel uses to access the Azure account. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration. (Optional.)
OwnershipTagKeys *Nullable[[]string] `json:"ownershipTagKeys,omitempty" yaml:"ownershipTagKeys,omitempty" example:"['tag_key1', 'tag_key2']"` // An array of tag keys used to associate ownership from an integration. Max 5. (Optional.)
SubscriptionId *Nullable[string] `json:"subscriptionId,omitempty" yaml:"subscriptionId,omitempty" example:"example_value"` // The subscription OpsLevel uses to access the Azure account. (Optional.)
TagsOverrideOwnership *Nullable[bool] `json:"tagsOverrideOwnership,omitempty" yaml:"tagsOverrideOwnership,omitempty" example:"false"` // Allow tags imported from Azure to override ownership set in OpsLevel directly. (Optional.)
TenantId *Nullable[string] `json:"tenantId,omitempty" yaml:"tenantId,omitempty" example:"example_value"` // The tenant OpsLevel uses to access the Azure account. (Optional.)
}
// CategoryCreateInput specifies the input fields used to create a category.
type CategoryCreateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the category. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the category. (Required.)
}
// CategoryDeleteInput specifies the input fields used to delete a category.
type CategoryDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category to be deleted. (Required.)
}
// CategoryUpdateInput specifies the input fields used to update a category.
type CategoryUpdateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the category. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category to be updated. (Required.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the category. (Optional.)
}
// CheckAlertSourceUsageCreateInput specifies the input fields used to create an alert source usage check.
type CheckAlertSourceUsageCreateInput struct {
AlertSourceNamePredicate *PredicateInput `json:"alertSourceNamePredicate,omitempty" yaml:"alertSourceNamePredicate,omitempty"` // The condition that the alert source name should satisfy to be evaluated. (Optional.)
AlertSourceType *AlertSourceTypeEnum `json:"alertSourceType,omitempty" yaml:"alertSourceType,omitempty" example:"datadog"` // The type of the alert source. (Optional.)
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckAlertSourceUsageUpdateInput specifies the input fields used to update an alert source usage check.
type CheckAlertSourceUsageUpdateInput struct {
AlertSourceNamePredicate *PredicateUpdateInput `json:"alertSourceNamePredicate,omitempty" yaml:"alertSourceNamePredicate,omitempty"` // The condition that the alert source name should satisfy to be evaluated. (Optional.)
AlertSourceType *AlertSourceTypeEnum `json:"alertSourceType,omitempty" yaml:"alertSourceType,omitempty" example:"datadog"` // The type of the alert source. (Optional.)
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckCodeIssueCreateInput specifies the input fields used to create a code issue check.
type CheckCodeIssueCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
Constraint CheckCodeIssueConstraintEnum `json:"constraint" yaml:"constraint" example:"any"` // The type of constraint used in evaluation the code issues check. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
IssueName *Nullable[string] `json:"issueName,omitempty" yaml:"issueName,omitempty" example:"example_value"` // The issue name used for code issue lookup. (Optional.)
IssueType *Nullable[[]string] `json:"issueType,omitempty" yaml:"issueType,omitempty" example:"['bug', 'error']"` // The type of code issue to consider. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
MaxAllowed *int `json:"maxAllowed,omitempty" yaml:"maxAllowed,omitempty" example:"3"` // The threshold count of code issues beyond which the check starts failing. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
ResolutionTime *CodeIssueResolutionTimeInput `json:"resolutionTime,omitempty" yaml:"resolutionTime,omitempty"` // The resolution time recommended by the reporting source of the code issue. (Optional.)
Severity *Nullable[[]string] `json:"severity,omitempty" yaml:"severity,omitempty" example:"['sev1', 'sev2']"` // The severity levels of the issue. (Optional.)
}
// CheckCodeIssueUpdateInput specifies the input fields used to update an exasting code issue check.
type CheckCodeIssueUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
Constraint CheckCodeIssueConstraintEnum `json:"constraint" yaml:"constraint" example:"any"` // The type of constraint used in evaluation the code issues check. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
IssueName *Nullable[string] `json:"issueName,omitempty" yaml:"issueName,omitempty" example:"example_value"` // The issue name used for code issue lookup. (Optional.)
IssueType *Nullable[[]string] `json:"issueType,omitempty" yaml:"issueType,omitempty" example:"['bug', 'error']"` // The type of code issue to consider. (Optional.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
MaxAllowed *int `json:"maxAllowed,omitempty" yaml:"maxAllowed,omitempty" example:"3"` // The threshold count of code issues beyond which the check starts failing. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
ResolutionTime *CodeIssueResolutionTimeInput `json:"resolutionTime,omitempty" yaml:"resolutionTime,omitempty"` // The resolution time recommended by the reporting source of the code issue. (Optional.)
Severity *Nullable[[]string] `json:"severity,omitempty" yaml:"severity,omitempty" example:"['sev1', 'sev2']"` // The severity levels of the issue. (Optional.)
}
// CheckCopyInput represents information about the check(s) that are to be copied.
type CheckCopyInput struct {
CheckIds []ID `json:"checkIds" yaml:"checkIds" example:"['Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk', 'Z2lkOi8vc2VydmljZS85ODc2NTQzMjE']"` // The IDs of the checks to be copied. (Required.)
Move *Nullable[bool] `json:"move,omitempty" yaml:"move,omitempty" example:"false"` // If set to true, the original checks will be deleted after being successfully copied. (Optional.)
TargetCategoryId ID `json:"targetCategoryId" yaml:"targetCategoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the category to which the checks are copied. Belongs to either the rubric or a scorecard. (Required.)
TargetLevelId *Nullable[ID] `json:"targetLevelId,omitempty" yaml:"targetLevelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the level which the copied checks are associated with. (Optional.)
}
// CheckCustomEventCreateInput represents creates a custom event check.
type CheckCustomEventCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
IntegrationId ID `json:"integrationId" yaml:"integrationId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The integration id this check will use. (Required.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
PassPending *Nullable[bool] `json:"passPending,omitempty" yaml:"passPending,omitempty" example:"false"` // True if this check should pass by default. Otherwise the default 'pending' state counts as a failure. (Optional.)
ResultMessage *Nullable[string] `json:"resultMessage,omitempty" yaml:"resultMessage,omitempty" example:"example_value"` // The check result message template. It is compiled with Liquid and formatted in Markdown. [More info about liquid templates](https://docs.opslevel.com/docs/checks/payload-checks/#liquid-templating). (Optional.)
ServiceSelector string `json:"serviceSelector" yaml:"serviceSelector" example:"example_value"` // A jq expression that will be ran against your payload. This will parse out the service identifier. [More info about jq](https://jqplay.org/). (Required.)
SuccessCondition string `json:"successCondition" yaml:"successCondition" example:"example_value"` // A jq expression that will be ran against your payload. A truthy value will result in the check passing. [More info about jq](https://jqplay.org/). (Required.)
}
// CheckCustomEventUpdateInput specifies the input fields used to update a custom event check.
type CheckCustomEventUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
IntegrationId *Nullable[ID] `json:"integrationId,omitempty" yaml:"integrationId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The integration id this check will use. (Optional.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
PassPending *Nullable[bool] `json:"passPending,omitempty" yaml:"passPending,omitempty" example:"false"` // True if this check should pass by default. Otherwise the default 'pending' state counts as a failure. (Optional.)
ResultMessage *Nullable[string] `json:"resultMessage,omitempty" yaml:"resultMessage,omitempty" example:"example_value"` // The check result message template. It is compiled with Liquid and formatted in Markdown. [More info about liquid templates](https://docs.opslevel.com/docs/checks/payload-checks/#liquid-templating). (Optional.)
ServiceSelector *Nullable[string] `json:"serviceSelector,omitempty" yaml:"serviceSelector,omitempty" example:"example_value"` // A jq expression that will be ran against your payload. This will parse out the service identifier. [More info about jq](https://jqplay.org/). (Optional.)
SuccessCondition *Nullable[string] `json:"successCondition,omitempty" yaml:"successCondition,omitempty" example:"example_value"` // A jq expression that will be ran against your payload. A truthy value will result in the check passing. [More info about jq](https://jqplay.org/). (Optional.)
}
// CheckDeleteInput specifies the input fields used to delete a check.
type CheckDeleteInput struct {
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be deleted. (Optional.)
}
// CheckGitBranchProtectionCreateInput specifies the input fields used to create a branch protection check.
type CheckGitBranchProtectionCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckGitBranchProtectionUpdateInput specifies the input fields used to update a branch protection check.
type CheckGitBranchProtectionUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckHasDocumentationCreateInput specifies the input fields used to create a documentation check.
type CheckHasDocumentationCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
DocumentSubtype HasDocumentationSubtypeEnum `json:"documentSubtype" yaml:"documentSubtype" example:"openapi"` // The subtype of the document. (Required.)
DocumentType HasDocumentationTypeEnum `json:"documentType" yaml:"documentType" example:"api"` // The type of the document. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckHasDocumentationUpdateInput specifies the input fields used to update a documentation check.
type CheckHasDocumentationUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
DocumentSubtype *HasDocumentationSubtypeEnum `json:"documentSubtype,omitempty" yaml:"documentSubtype,omitempty" example:"openapi"` // The subtype of the document. (Optional.)
DocumentType *HasDocumentationTypeEnum `json:"documentType,omitempty" yaml:"documentType,omitempty" example:"api"` // The type of the document. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckHasRecentDeployCreateInput specifies the input fields used to create a recent deploys check.
type CheckHasRecentDeployCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
Days int `json:"days" yaml:"days" example:"3"` // The number of days to check since the last deploy. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckHasRecentDeployUpdateInput specifies the input fields used to update a has recent deploy check.
type CheckHasRecentDeployUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
Days *int `json:"days,omitempty" yaml:"days,omitempty" example:"3"` // The number of days to check since the last deploy. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckManualCreateInput specifies the input fields used to create a manual check.
type CheckManualCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
UpdateFrequency *ManualCheckFrequencyInput `json:"updateFrequency,omitempty" yaml:"updateFrequency,omitempty"` // Defines the minimum frequency of the updates. (Optional.)
UpdateRequiresComment bool `json:"updateRequiresComment" yaml:"updateRequiresComment" example:"false"` // Whether the check requires a comment or not. (Required.)
}
// CheckManualUpdateInput specifies the input fields used to update a manual check.
type CheckManualUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
UpdateFrequency *ManualCheckFrequencyUpdateInput `json:"updateFrequency,omitempty" yaml:"updateFrequency,omitempty"` // Defines the minimum frequency of the updates. (Optional.)
UpdateRequiresComment *Nullable[bool] `json:"updateRequiresComment,omitempty" yaml:"updateRequiresComment,omitempty" example:"false"` // Whether the check requires a comment or not. (Optional.)
}
// CheckPackageVersionCreateInput represents information about the package version check to be created.
type CheckPackageVersionCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
MissingPackageResult *CheckResultStatusEnum `json:"missingPackageResult,omitempty" yaml:"missingPackageResult,omitempty" example:"failed"` // The check result if the package isn't being used by a service. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
PackageConstraint PackageConstraintEnum `json:"packageConstraint" yaml:"packageConstraint" example:"does_not_exist"` // The package constraint the service is to be checked for. (Required.)
PackageManager PackageManagerEnum `json:"packageManager" yaml:"packageManager" example:"alpm"` // The package manager (ecosystem) this package relates to. (Required.)
PackageName string `json:"packageName" yaml:"packageName" example:"example_value"` // The name of the package to be checked. (Required.)
PackageNameIsRegex *Nullable[bool] `json:"packageNameIsRegex,omitempty" yaml:"packageNameIsRegex,omitempty" example:"false"` // Whether or not the value in the package name field is a regular expression. (Optional.)
VersionConstraintPredicate *PredicateInput `json:"versionConstraintPredicate,omitempty" yaml:"versionConstraintPredicate,omitempty"` // The predicate that describes the version constraint the package must satisfy. (Optional.)
}
// CheckPackageVersionUpdateInput represents information about the package version check to be updated.
type CheckPackageVersionUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
MissingPackageResult *CheckResultStatusEnum `json:"missingPackageResult,omitempty" yaml:"missingPackageResult,omitempty" example:"failed"` // The check result if the package isn't being used by a service. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
PackageConstraint *PackageConstraintEnum `json:"packageConstraint,omitempty" yaml:"packageConstraint,omitempty" example:"does_not_exist"` // The package constraint the service is to be checked for. (Optional.)
PackageManager *PackageManagerEnum `json:"packageManager,omitempty" yaml:"packageManager,omitempty" example:"alpm"` // The package manager (ecosystem) this package relates to. (Optional.)
PackageName *Nullable[string] `json:"packageName,omitempty" yaml:"packageName,omitempty" example:"example_value"` // The name of the package to be checked. (Optional.)
PackageNameIsRegex *Nullable[bool] `json:"packageNameIsRegex,omitempty" yaml:"packageNameIsRegex,omitempty" example:"false"` // Whether or not the value in the package name field is a regular expression. (Optional.)
VersionConstraintPredicate *PredicateUpdateInput `json:"versionConstraintPredicate,omitempty" yaml:"versionConstraintPredicate,omitempty"` // The predicate that describes the version constraint the package must satisfy. (Optional.)
}
// CheckRepositoryFileCreateInput specifies the input fields used to create a repo file check.
type CheckRepositoryFileCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FileContentsPredicate *PredicateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the file content. (Optional.)
FilePaths []string `json:"filePaths" yaml:"filePaths" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths. (Required.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
UseAbsoluteRoot *Nullable[bool] `json:"useAbsoluteRoot,omitempty" yaml:"useAbsoluteRoot,omitempty" example:"false"` // Whether the checks looks at the absolute root of a repo or the relative root (the directory specified when attached a repo to a service). (Optional.)
}
// CheckRepositoryFileUpdateInput specifies the input fields used to update a repo file check.
type CheckRepositoryFileUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FileContentsPredicate *PredicateUpdateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the file content. (Optional.)
FilePaths *Nullable[[]string] `json:"filePaths,omitempty" yaml:"filePaths,omitempty" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
UseAbsoluteRoot *Nullable[bool] `json:"useAbsoluteRoot,omitempty" yaml:"useAbsoluteRoot,omitempty" example:"false"` // Whether the checks looks at the absolute root of a repo or the relative root (the directory specified when attached a repo to a service). (Optional.)
}
// CheckRepositoryGrepCreateInput specifies the input fields used to create a repo grep check.
type CheckRepositoryGrepCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FileContentsPredicate PredicateInput `json:"fileContentsPredicate" yaml:"fileContentsPredicate"` // Condition to match the file content. (Required.)
FilePaths []string `json:"filePaths" yaml:"filePaths" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths. (Required.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckRepositoryGrepUpdateInput specifies the input fields used to update a repo file check.
type CheckRepositoryGrepUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FileContentsPredicate *PredicateUpdateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the file content. (Optional.)
FilePaths *Nullable[[]string] `json:"filePaths,omitempty" yaml:"filePaths,omitempty" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckRepositoryIntegratedCreateInput specifies the input fields used to create a repository integrated check.
type CheckRepositoryIntegratedCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckRepositoryIntegratedUpdateInput specifies the input fields used to update a repository integrated check.
type CheckRepositoryIntegratedUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckRepositorySearchCreateInput specifies the input fields used to create a repo search check.
type CheckRepositorySearchCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FileContentsPredicate PredicateInput `json:"fileContentsPredicate" yaml:"fileContentsPredicate"` // Condition to match the text content. (Required.)
FileExtensions *Nullable[[]string] `json:"fileExtensions,omitempty" yaml:"fileExtensions,omitempty" example:"['go', 'py', 'rb']"` // Restrict the search to files of given extensions. Extensions should contain only letters and numbers. For example: `['py', 'rb']`. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckRepositorySearchUpdateInput specifies the input fields used to update a repo search check.
type CheckRepositorySearchUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FileContentsPredicate *PredicateUpdateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the text content. (Optional.)
FileExtensions *Nullable[[]string] `json:"fileExtensions,omitempty" yaml:"fileExtensions,omitempty" example:"['go', 'py', 'rb']"` // Restrict the search to files of given extensions. Extensions should contain only letters and numbers. For example: `['py', 'rb']`. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckServiceConfigurationCreateInput specifies the input fields used to create a configuration check.
type CheckServiceConfigurationCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckServiceConfigurationUpdateInput specifies the input fields used to update a configuration check.
type CheckServiceConfigurationUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckServiceDependencyCreateInput specifies the input fields used to create a service dependency check.
type CheckServiceDependencyCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
}
// CheckServiceDependencyUpdateInput specifies the input fields used to update a service dependency check.
type CheckServiceDependencyUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
}
// CheckServiceOwnershipCreateInput specifies the input fields used to create an ownership check.
type CheckServiceOwnershipCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
ContactMethod *Nullable[string] `json:"contactMethod,omitempty" yaml:"contactMethod,omitempty" example:"example_value"` // The type of contact method that an owner should provide (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
RequireContactMethod *Nullable[bool] `json:"requireContactMethod,omitempty" yaml:"requireContactMethod,omitempty" example:"false"` // Whether to require a contact method for a service owner or not (Optional.)
TagKey *Nullable[string] `json:"tagKey,omitempty" yaml:"tagKey,omitempty" example:"example_value"` // The tag key that should exist for a service owner. (Optional.)
TagPredicate *PredicateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value. (Optional.)
}
// CheckServiceOwnershipUpdateInput specifies the input fields used to update an ownership check.
type CheckServiceOwnershipUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
ContactMethod *Nullable[string] `json:"contactMethod,omitempty" yaml:"contactMethod,omitempty" example:"example_value"` // The type of contact method that an owner should provide (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
RequireContactMethod *Nullable[bool] `json:"requireContactMethod,omitempty" yaml:"requireContactMethod,omitempty" example:"false"` // Whether to require a contact method for a service owner or not (Optional.)
TagKey *Nullable[string] `json:"tagKey,omitempty" yaml:"tagKey,omitempty" example:"example_value"` // The tag key that should exist for a service owner. (Optional.)
TagPredicate *PredicateUpdateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value. (Optional.)
}
// CheckServicePropertyCreateInput specifies the input fields used to create a service property check.
type CheckServicePropertyCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
ComponentType *IdentifierInput `json:"componentType,omitempty" yaml:"componentType,omitempty"` // The Component Type that a custom property belongs to. Defaults to Service properties if not provided. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
PropertyDefinition *IdentifierInput `json:"propertyDefinition,omitempty" yaml:"propertyDefinition,omitempty"` // The secondary key of the property that the check will verify (e.g. the specific custom property). (Optional.)
PropertyValuePredicate *PredicateInput `json:"propertyValuePredicate,omitempty" yaml:"propertyValuePredicate,omitempty"` // The condition that should be satisfied by the service property value. (Optional.)
ServiceProperty ServicePropertyTypeEnum `json:"serviceProperty" yaml:"serviceProperty" example:"custom_property"` // The property of the service that the check will verify. (Required.)
}
// CheckServicePropertyUpdateInput specifies the input fields used to update a service property check.
type CheckServicePropertyUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
ComponentType *IdentifierInput `json:"componentType,omitempty" yaml:"componentType,omitempty"` // The Component Type that a custom property belongs to. Defaults to Service properties if not provided. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
PropertyDefinition *IdentifierInput `json:"propertyDefinition,omitempty" yaml:"propertyDefinition,omitempty"` // The secondary key of the property that the check will verify (e.g. the specific custom property). (Optional.)
PropertyValuePredicate *PredicateUpdateInput `json:"propertyValuePredicate,omitempty" yaml:"propertyValuePredicate,omitempty"` // The condition that should be satisfied by the service property value. (Optional.)
ServiceProperty *ServicePropertyTypeEnum `json:"serviceProperty,omitempty" yaml:"serviceProperty,omitempty" example:"custom_property"` // The property of the service that the check will verify. (Optional.)
}
// CheckTagDefinedCreateInput specifies the input fields used to create a tag check.
type CheckTagDefinedCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
TagKey string `json:"tagKey" yaml:"tagKey" example:"example_value"` // The tag key where the tag predicate should be applied. (Required.)
TagPredicate *PredicateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value. (Optional.)
}
// CheckTagDefinedUpdateInput specifies the input fields used to update a tag defined check.
type CheckTagDefinedUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
TagKey *Nullable[string] `json:"tagKey,omitempty" yaml:"tagKey,omitempty" example:"example_value"` // The tag key where the tag predicate should be applied. (Optional.)
TagPredicate *PredicateUpdateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value. (Optional.)
}
// CheckToPromoteInput specifies the input fields used to promote a campaign check to the rubric.
type CheckToPromoteInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the category that the promoted check will be linked to. (Required.)
CheckId ID `json:"checkId" yaml:"checkId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the check to be promoted to the rubric. (Required.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the level that the promoted check will be linked to. (Required.)
}
// CheckToolUsageCreateInput specifies the input fields used to create a tool usage check.
type CheckToolUsageCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Required.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
EnvironmentPredicate *PredicateInput `json:"environmentPredicate,omitempty" yaml:"environmentPredicate,omitempty"` // The condition that the environment should satisfy to be evaluated. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check. (Optional.)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check. (Optional.)
ToolCategory ToolCategory `json:"toolCategory" yaml:"toolCategory" example:"admin"` // The category that the tool belongs to. (Required.)
ToolNamePredicate *PredicateInput `json:"toolNamePredicate,omitempty" yaml:"toolNamePredicate,omitempty"` // The condition that the tool name should satisfy to be evaluated. (Optional.)
ToolUrlPredicate *PredicateInput `json:"toolUrlPredicate,omitempty" yaml:"toolUrlPredicate,omitempty"` // The condition that the tool url should satisfy to be evaluated. (Optional.)
}
// CheckToolUsageUpdateInput specifies the input fields used to update a tool usage check.
type CheckToolUsageUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to. (Optional.)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled. (Optional.)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not. (Optional.)
EnvironmentPredicate *PredicateUpdateInput `json:"environmentPredicate,omitempty" yaml:"environmentPredicate,omitempty"` // The condition that the environment should satisfy to be evaluated. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated. (Required.)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check. (Optional.)
ToolCategory *ToolCategory `json:"toolCategory,omitempty" yaml:"toolCategory,omitempty" example:"admin"` // The category that the tool belongs to. (Optional.)
ToolNamePredicate *PredicateUpdateInput `json:"toolNamePredicate,omitempty" yaml:"toolNamePredicate,omitempty"` // The condition that the tool name should satisfy to be evaluated. (Optional.)
ToolUrlPredicate *PredicateUpdateInput `json:"toolUrlPredicate,omitempty" yaml:"toolUrlPredicate,omitempty"` // The condition that the tool url should satisfy to be evaluated. (Optional.)
}
// CodeIssueResolutionTimeInput represents the allowed threshold for how long an issue has been detected before the check starts failing.
type CodeIssueResolutionTimeInput struct {
Unit CodeIssueResolutionTimeUnitEnum `json:"unit" yaml:"unit" example:"day"` // (Required.)
Value int `json:"value" yaml:"value" example:"3"` // (Required.)
}
// ComponentTypeInput specifies the input fields used to create a component type.
type ComponentTypeInput struct {
Alias *Nullable[string] `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The unique alias of the component type. (Optional.)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The unique alias of the component type. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The unique name of the component type. (Optional.)
Properties *[]ComponentTypePropertyDefinitionInput `json:"properties,omitempty" yaml:"properties,omitempty" example:"[]"` // A list of property definitions for the component type. (Optional.)
}
// ComponentTypePropertyDefinitionInput represents the input for defining a property on a component type.
type ComponentTypePropertyDefinitionInput struct {
Alias string `json:"alias" yaml:"alias" example:"example_value"` // The human-friendly, unique identifier for the resource. (Required.)
AllowedInConfigFiles bool `json:"allowedInConfigFiles" yaml:"allowedInConfigFiles" example:"false"` // Whether or not the property is allowed to be set in opslevel.yml config files. (Required.)
Description string `json:"description" yaml:"description" example:"example_value"` // The description of the property definition. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The name of the property definition. (Required.)
PropertyDisplayStatus PropertyDisplayStatusEnum `json:"propertyDisplayStatus" yaml:"propertyDisplayStatus" example:"hidden"` // The display status of the custom property on service pages. (Required.)
Schema JSONSchema `json:"schema" yaml:"schema" example:"SCHEMA_TBD"` // The schema of the property definition. (Required.)
}
// ContactCreateInput specifies the input fields used to create a contact.
type ContactCreateInput struct {
Address string `json:"address" yaml:"address" example:"example_value"` // The contact address. Examples: [email protected] for type `email`, https://opslevel.com for type `web`. (Required.)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name shown in the UI for the contact. (Optional.)
DisplayType *Nullable[string] `json:"displayType,omitempty" yaml:"displayType,omitempty" example:"example_value"` // The type shown in the UI for the contact. (Optional.)
ExternalId *Nullable[string] `json:"externalId,omitempty" yaml:"externalId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The remote identifier of the contact method. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of this contact. (Optional.)
TeamAlias *Nullable[string] `json:"teamAlias,omitempty" yaml:"teamAlias,omitempty" example:"example_value"` // The alias of the team the contact belongs to. (Optional.)
TeamId *Nullable[ID] `json:"teamId,omitempty" yaml:"teamId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team the contact belongs to. (Optional.)
Type ContactType `json:"type" yaml:"type" example:"email"` // The method of contact [email, slack, slack_handle, web, microsoft_teams]. (Required.)
}
// ContactDeleteInput specifies the input fields used to delete a contact.
type ContactDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The `id` of the contact you wish to delete. (Required.)
}
// ContactInput specifies the input fields used to create a contact.
type ContactInput struct {
Address string `json:"address" yaml:"address" example:"example_value"` // The contact address. Examples: [email protected] for type `email`, https://opslevel.com for type `web`. (Required.)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name shown in the UI for the contact. (Optional.)
Type ContactType `json:"type" yaml:"type" example:"email"` // The method of contact [email, slack, slack_handle, web, microsoft_teams]. (Required.)
}
// ContactUpdateInput specifies the input fields used to update a contact.
type ContactUpdateInput struct {
Address *Nullable[string] `json:"address,omitempty" yaml:"address,omitempty" example:"example_value"` // The contact address. Examples: [email protected] for type `email`, https://opslevel.com for type `web`. (Optional.)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name shown in the UI for the contact. (Optional.)
DisplayType *Nullable[string] `json:"displayType,omitempty" yaml:"displayType,omitempty" example:"example_value"` // The type shown in the UI for the contact. (Optional.)
ExternalId *Nullable[string] `json:"externalId,omitempty" yaml:"externalId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The remote identifier of the contact method. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The unique identifier for the contact. (Required.)
MakeDefault *Nullable[bool] `json:"makeDefault,omitempty" yaml:"makeDefault,omitempty" example:"false"` // Makes the contact the default for the given type. Only available for team contacts. (Optional.)
Type *ContactType `json:"type,omitempty" yaml:"type,omitempty" example:"email"` // The method of contact [email, slack, slack_handle, web, microsoft_teams]. (Optional.)
}
// CustomActionsTriggerDefinitionCreateInput specifies the input fields used in the `customActionsTriggerDefinitionCreate` mutation.
type CustomActionsTriggerDefinitionCreateInput struct {
AccessControl *CustomActionsTriggerDefinitionAccessControlEnum `json:"accessControl,omitempty" yaml:"accessControl,omitempty" example:"admins"` // The set of users that should be able to use the trigger definition. (Optional.)
ActionId *Nullable[ID] `json:"actionId,omitempty" yaml:"actionId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The action that will be triggered by the Trigger Definition. (Optional.)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of what the Trigger Definition will do, supports Markdown. (Optional.)
EntityType *CustomActionsEntityTypeEnum `json:"entityType,omitempty" yaml:"entityType,omitempty" example:"GLOBAL"` // The entity type to associate with the Trigger Definition. (Optional.)
ExtendedTeamAccess *[]IdentifierInput `json:"extendedTeamAccess,omitempty" yaml:"extendedTeamAccess,omitempty" example:"[]"` // The set of additional teams who can invoke this Trigger Definition. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The filter that will determine which services apply to the Trigger Definition. (Optional.)
ManualInputsDefinition *Nullable[string] `json:"manualInputsDefinition,omitempty" yaml:"manualInputsDefinition,omitempty" example:"example_value"` // The YAML definition of custom inputs for the Trigger Definition. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The name of the Trigger Definition. (Required.)
OwnerId ID `json:"ownerId" yaml:"ownerId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The owner of the Trigger Definition. (Required.)
Published *Nullable[bool] `json:"published,omitempty" yaml:"published,omitempty" example:"false"` // The published state of the action; true if the definition is ready for use; false if it is a draft. (Optional.)
ResponseTemplate *Nullable[string] `json:"responseTemplate,omitempty" yaml:"responseTemplate,omitempty" example:"example_value"` // The liquid template used to parse the response from the External Action. (Optional.)
}
// CustomActionsTriggerDefinitionUpdateInput specifies the input fields used in the `customActionsTriggerDefinitionUpdate` mutation.
type CustomActionsTriggerDefinitionUpdateInput struct {
AccessControl *CustomActionsTriggerDefinitionAccessControlEnum `json:"accessControl,omitempty" yaml:"accessControl,omitempty" example:"admins"` // The set of users that should be able to use the trigger definition. (Optional.)
Action *CustomActionsWebhookActionUpdateInput `json:"action,omitempty" yaml:"action,omitempty"` // The details for the action to update for the Trigger Definition. (Optional.)
ActionId *Nullable[ID] `json:"actionId,omitempty" yaml:"actionId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The action that will be triggered by the Trigger Definition. (Optional.)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of what the Trigger Definition will do, support Markdown. (Optional.)
EntityType *CustomActionsEntityTypeEnum `json:"entityType,omitempty" yaml:"entityType,omitempty" example:"GLOBAL"` // The entity type to associate with the Trigger Definition. (Optional.)
ExtendedTeamAccess *[]IdentifierInput `json:"extendedTeamAccess,omitempty" yaml:"extendedTeamAccess,omitempty" example:"[]"` // The set of additional teams who can invoke this Trigger Definition. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The filter that will determine which services apply to the Trigger Definition. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the trigger definition. (Required.)
ManualInputsDefinition *Nullable[string] `json:"manualInputsDefinition,omitempty" yaml:"manualInputsDefinition,omitempty" example:"example_value"` // The YAML definition of custom inputs for the Trigger Definition. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the Trigger Definition. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The owner of the Trigger Definition. (Optional.)
Published *Nullable[bool] `json:"published,omitempty" yaml:"published,omitempty" example:"false"` // The published state of the action; true if the definition is ready for use; false if it is a draft. (Optional.)
ResponseTemplate *Nullable[string] `json:"responseTemplate,omitempty" yaml:"responseTemplate,omitempty" example:"example_value"` // The liquid template used to parse the response from the External Action. (Optional.)
}
// CustomActionsWebhookActionCreateInput specifies the input fields used in the `customActionsWebhookActionCreate` mutation.
type CustomActionsWebhookActionCreateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description that gets assigned to the Webhook Action you're creating. (Optional.)
Headers *JSON `json:"headers,omitempty" yaml:"headers,omitempty" example:"{\"name\":\"my-big-query\",\"engine\":\"BigQuery\",\"endpoint\":\"https://google.com\",\"replica\":false}"` // HTTP headers be passed along with your Webhook when triggered. (Optional.)
HttpMethod CustomActionsHttpMethodEnum `json:"httpMethod" yaml:"httpMethod" example:"DELETE"` // HTTP used when the Webhook is triggered. Either POST or PUT. (Required.)
LiquidTemplate *Nullable[string] `json:"liquidTemplate,omitempty" yaml:"liquidTemplate,omitempty" example:"example_value"` // Template that can be used to generate a Webhook payload. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The name that gets assigned to the Webhook Action you're creating. (Required.)
WebhookUrl string `json:"webhookUrl" yaml:"webhookUrl" example:"example_value"` // The URL that you wish to send the Webhook to when triggered. (Required.)
}
// CustomActionsWebhookActionUpdateInput represents inputs that specify the details of a Webhook Action you wish to update.
type CustomActionsWebhookActionUpdateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description that gets assigned to the Webhook Action you're creating. (Optional.)
Headers *JSON `json:"headers,omitempty" yaml:"headers,omitempty" example:"{\"name\":\"my-big-query\",\"engine\":\"BigQuery\",\"endpoint\":\"https://google.com\",\"replica\":false}"` // HTTP headers be passed along with your Webhook when triggered. (Optional.)
HttpMethod *CustomActionsHttpMethodEnum `json:"httpMethod,omitempty" yaml:"httpMethod,omitempty" example:"DELETE"` // HTTP used when the Webhook is triggered. Either POST or PUT. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the Webhook Action you wish to update. (Required.)
LiquidTemplate *Nullable[string] `json:"liquidTemplate,omitempty" yaml:"liquidTemplate,omitempty" example:"example_value"` // Template that can be used to generate a Webhook payload. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name that gets assigned to the Webhook Action you're creating. (Optional.)
WebhookUrl *Nullable[string] `json:"webhookUrl,omitempty" yaml:"webhookUrl,omitempty" example:"example_value"` // The URL that you wish to send the Webhook too when triggered. (Optional.)
}
// DeleteInput specifies the input fields used to delete an entity.
type DeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the entity to be deleted. (Required.)
}
// DomainInput specifies the input fields for a domain.
type DomainInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description for the domain. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name for the domain. (Optional.)
Note *Nullable[string] `json:"note,omitempty" yaml:"note,omitempty" example:"example_value"` // Additional information about the domain. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner for the domain. (Optional.)
}
// EventIntegrationInput
type EventIntegrationInput struct {
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the event integration. (Optional.)
Type EventIntegrationEnum `json:"type" yaml:"type" example:"apiDoc"` // The type of event integration to create. (Required.)
}
// EventIntegrationUpdateInput
type EventIntegrationUpdateInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the event integration to update. (Required.)
Name string `json:"name" yaml:"name" example:"example_value"` // The name of the event integration. (Required.)
}
// ExternalUuidMutationInput specifies the input used for modifying a resource's external UUID.
type ExternalUuidMutationInput struct {
ResourceId ID `json:"resourceId" yaml:"resourceId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the resource. (Required.)
}
// FilterCreateInput specifies the input fields used to create a filter.
type FilterCreateInput struct {
Connective *ConnectiveEnum `json:"connective,omitempty" yaml:"connective,omitempty" example:"and"` // The logical operator to be used in conjunction with predicates. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the filter. (Required.)
Predicates *[]FilterPredicateInput `json:"predicates,omitempty" yaml:"predicates,omitempty" example:"[]"` // The list of predicates used to select which services apply to the filter. (Optional.)
}
// FilterPredicateInput represents a condition that should be satisfied.
type FilterPredicateInput struct {
CaseSensitive *Nullable[bool] `json:"caseSensitive,omitempty" yaml:"caseSensitive,omitempty" example:"false"` // (Optional.)
Key PredicateKeyEnum `json:"key" yaml:"key" example:"aliases"` // The condition key used by the predicate. (Required.)
KeyData *Nullable[string] `json:"keyData,omitempty" yaml:"keyData,omitempty" example:"example_value"` // Additional data used by the predicate. This field is used by predicates with key = 'tags' to specify the tag key. For example, to create a predicate for services containing the tag 'db:mysql', set keyData = 'db' and value = 'mysql'. (Optional.)
Type PredicateTypeEnum `json:"type" yaml:"type" example:"belongs_to"` // The condition type used by the predicate. (Required.)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The condition value used by the predicate. (Optional.)
}
// FilterUpdateInput specifies the input fields used to update a filter.
type FilterUpdateInput struct {
Connective *ConnectiveEnum `json:"connective,omitempty" yaml:"connective,omitempty" example:"and"` // The logical operator to be used in conjunction with predicates. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter. (Required.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the filter. (Optional.)
Predicates *[]FilterPredicateInput `json:"predicates,omitempty" yaml:"predicates,omitempty" example:"[]"` // The list of predicates used to select which services apply to the filter. All existing predicates will be replaced by these predicates. (Optional.)
}
// GoogleCloudIntegrationInput specifies the input fields used to create and update a Google Cloud integration.
type GoogleCloudIntegrationInput struct {
ClientEmail *Nullable[string] `json:"clientEmail,omitempty" yaml:"clientEmail,omitempty" example:"example_value"` // The service account email OpsLevel uses to access the Google Cloud account. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration. (Optional.)
OwnershipTagKeys *Nullable[[]string] `json:"ownershipTagKeys,omitempty" yaml:"ownershipTagKeys,omitempty" example:"['tag_key1', 'tag_key2']"` // An array of tag keys used to associate ownership from an integration. Max 5. (Optional.)
PrivateKey *Nullable[string] `json:"privateKey,omitempty" yaml:"privateKey,omitempty" example:"example_value"` // The private key for the service account that OpsLevel uses to access the Google Cloud account. (Optional.)
TagsOverrideOwnership *Nullable[bool] `json:"tagsOverrideOwnership,omitempty" yaml:"tagsOverrideOwnership,omitempty" example:"false"` // Allow tags imported from Google Cloud to override ownership set in OpsLevel directly. (Optional.)
}
// IdentifierInput specifies the input fields used to identify a resource.
type IdentifierInput struct {
Alias *string `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The human-friendly, unique identifier for the resource. (Optional.)
Id *ID `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the resource. (Optional.)
}
// InfrastructureResourceInput specifies the input fields for a infrastructure resource.
type InfrastructureResourceInput struct {
Data *JSON `json:"data,omitempty" yaml:"data,omitempty" example:"{\"name\":\"my-big-query\",\"engine\":\"BigQuery\",\"endpoint\":\"https://google.com\",\"replica\":false}"` // The data for the infrastructure_resource. (Optional.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner for the infrastructure_resource. (Optional.)
ProviderData *InfrastructureResourceProviderDataInput `json:"providerData,omitempty" yaml:"providerData,omitempty"` // Data about the provider of the infrastructure resource. (Optional.)
ProviderResourceType *Nullable[string] `json:"providerResourceType,omitempty" yaml:"providerResourceType,omitempty" example:"example_value"` // The type of the infrastructure resource in its provider. (Optional.)
Schema *InfrastructureResourceSchemaInput `json:"schema,omitempty" yaml:"schema,omitempty"` // The schema for the infrastructure_resource that determines its type. (Optional.)
}
// InfrastructureResourceProviderDataInput specifies the input fields for data about an infrastructure resource's provider.
type InfrastructureResourceProviderDataInput struct {
AccountName string `json:"accountName" yaml:"accountName" example:"example_value"` // The account name of the provider. (Required.)
ExternalUrl *Nullable[string] `json:"externalUrl,omitempty" yaml:"externalUrl,omitempty" example:"example_value"` // The external URL of the infrastructure resource in its provider. (Optional.)
ProviderName *Nullable[string] `json:"providerName,omitempty" yaml:"providerName,omitempty" example:"example_value"` // The name of the provider (e.g. AWS, GCP, Azure). (Optional.)
}
// InfrastructureResourceSchemaInput specifies the schema for an infrastructure resource.
type InfrastructureResourceSchemaInput struct {
Type string `json:"type" yaml:"type" example:"example_value"` // The type of the infrastructure resource. (Required.)
}
// LevelCreateInput specifies the input fields used to create a level. The new level will be added as the highest level (greatest level index).
type LevelCreateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the level. (Optional.)
Index *int `json:"index,omitempty" yaml:"index,omitempty" example:"3"` // an integer allowing this level to be inserted between others. Must be unique per Rubric. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the level. (Required.)
}
// LevelDeleteInput specifies the input fields used to delete a level.
type LevelDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level to be deleted. (Required.)
}
// LevelUpdateInput specifies the input fields used to update a level.
type LevelUpdateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the level. (Optional.)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level to be updated. (Required.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the level. (Optional.)
}
// ManualCheckFrequencyInput represents defines a frequency for the check update.
type ManualCheckFrequencyInput struct {
FrequencyTimeScale FrequencyTimeScale `json:"frequencyTimeScale" yaml:"frequencyTimeScale" example:"day"` // The time scale type for the frequency. (Required.)
FrequencyValue int `json:"frequencyValue" yaml:"frequencyValue" example:"3"` // The value to be used together with the frequency scale. (Required.)
StartingDate iso8601.Time `json:"startingDate" yaml:"startingDate" example:"2025-01-05T01:00:00.000Z"` // The date that the check will start to evaluate. (Required.)
}
// ManualCheckFrequencyUpdateInput represents defines a frequency for the check update.
type ManualCheckFrequencyUpdateInput struct {
FrequencyTimeScale *FrequencyTimeScale `json:"frequencyTimeScale,omitempty" yaml:"frequencyTimeScale,omitempty" example:"day"` // The time scale type for the frequency. (Optional.)
FrequencyValue *Nullable[int] `json:"frequencyValue,omitempty" yaml:"frequencyValue,omitempty" example:"3"` // The value to be used together with the frequency scale. (Optional.)
StartingDate *Nullable[iso8601.Time] `json:"startingDate,omitempty" yaml:"startingDate,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date that the check will start to evaluate. (Optional.)
}
// MemberInput represents input for specifying members on a group.
type MemberInput struct {
Email string `json:"email" yaml:"email" example:"example_value"` // The user's email. (Required.)
}
// NewRelicIntegrationAccountsInput
type NewRelicIntegrationAccountsInput struct {
ApiKey string `json:"apiKey" yaml:"apiKey" example:"example_value"` // The API Key for the New Relic API. (Required.)
BaseUrl string `json:"baseUrl" yaml:"baseUrl" example:"example_value"` // The API URL for New Relic API. (Required.)
}
// NewRelicIntegrationInput
type NewRelicIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the New Relic API. (Optional.)
BaseUrl *Nullable[string] `json:"baseUrl,omitempty" yaml:"baseUrl,omitempty" example:"example_value"` // The API URL for New Relic API. (Optional.)
}
// OctopusDeployIntegrationInput specifies the input fields used to create and update an Octopus Deploy integration.
type OctopusDeployIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the Octopus Deploy API. (Optional.)
InstanceUrl *Nullable[string] `json:"instanceUrl,omitempty" yaml:"instanceUrl,omitempty" example:"example_value"` // The URL the Octopus Deploy instance if hosted on. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration. (Optional.)
}
// PayloadFilterInput represents input to be used to filter types.
type PayloadFilterInput struct {
Arg *Nullable[string] `json:"arg,omitempty" yaml:"arg,omitempty" example:"example_value"` // Value to be filtered. (Optional.)
Key PayloadFilterEnum `json:"key" yaml:"key" example:"integration_id"` // Field to be filtered. (Required.)
Type *BasicTypeEnum `json:"type,omitempty" yaml:"type,omitempty" example:"does_not_equal"` // Type of operation to be applied to value on the field. (Optional.)
}
// PredicateInput represents a condition that should be satisfied.
type PredicateInput struct {
Type PredicateTypeEnum `json:"type" yaml:"type" example:"belongs_to"` // The condition type used by the predicate. (Required.)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The condition value used by the predicate. (Optional.)
}
// PredicateUpdateInput represents a condition that should be satisfied.
type PredicateUpdateInput struct {
Type *PredicateTypeEnum `json:"type,omitempty" yaml:"type,omitempty" example:"belongs_to"` // The condition type used by the predicate. (Optional.)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The condition value used by the predicate. (Optional.)
}
// PropertyDefinitionInput represents the input for defining a property.
type PropertyDefinitionInput struct {
AllowedInConfigFiles *Nullable[bool] `json:"allowedInConfigFiles,omitempty" yaml:"allowedInConfigFiles,omitempty" example:"false"` // Whether or not the property is allowed to be set in opslevel.yml config files. (Optional.)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the property definition. (Optional.)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the property definition. (Optional.)
PropertyDisplayStatus *PropertyDisplayStatusEnum `json:"propertyDisplayStatus,omitempty" yaml:"propertyDisplayStatus,omitempty" example:"hidden"` // The display status of the custom property on service pages. (Optional.)
Schema *JSONSchema `json:"schema,omitempty" yaml:"schema,omitempty" example:"SCHEMA_TBD"` // The schema of the property definition. (Optional.)
}
// PropertyInput represents the input for setting a property.
type PropertyInput struct {
Definition IdentifierInput `json:"definition" yaml:"definition"` // The definition of the property. (Required.)
Owner IdentifierInput `json:"owner" yaml:"owner"` // The entity that the property has been assigned to. (Required.)
RunValidation *Nullable[bool] `json:"runValidation,omitempty" yaml:"runValidation,omitempty" example:"false"` // Validate the property value against the schema. On by default. (Optional.)
Value JsonString `json:"value" yaml:"value" example:"JSON_TBD"` // The value of the property. (Required.)
}
// RelationshipDefinition represents a source, target and relationship type specifying a relationship between two resources.
type RelationshipDefinition struct {
Source IdentifierInput `json:"source" yaml:"source"` // The resource that is the source of the relationship. alias is ambiguous in this context and is not supported. Please supply an id. (Required.)
Target IdentifierInput `json:"target" yaml:"target"` // The resource that is the target of the relationship. alias is ambiguous in this context and is not supported. Please supply an id. (Required.)
Type RelationshipTypeEnum `json:"type" yaml:"type" example:"belongs_to"` // The type of the relationship between source and target. (Required.)
}
// RepositoryUpdateInput specifies the input fields used to update a repository.
type RepositoryUpdateInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the repository to be updated. (Required.)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The team that owns the repository. (Optional.)
Visible *Nullable[bool] `json:"visible,omitempty" yaml:"visible,omitempty" example:"false"` // Indicates if the repository is visible. (Optional.)
}
// ScorecardInput represents input used to create scorecards.
type ScorecardInput struct {
AffectsOverallServiceLevels *Nullable[bool] `json:"affectsOverallServiceLevels,omitempty" yaml:"affectsOverallServiceLevels,omitempty" example:"false"` // (Optional.)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // Description of the scorecard. (Optional.)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Filter used by the scorecard to restrict services. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // Name of the scorecard. (Required.)
OwnerId ID `json:"ownerId" yaml:"ownerId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Owner of the scorecard. Can currently be a team or a group. (Required.)
}
// SecretInput represents arguments for secret operations.
type SecretInput struct {
Owner *IdentifierInput `json:"owner,omitempty" yaml:"owner,omitempty"` // The owner of this secret. (Optional.)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // A sensitive value. (Optional.)
}
// ServiceCreateInput specifies the input fields used in the `serviceCreate` mutation.
type ServiceCreateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // A brief description of the service. (Optional.)
Framework *Nullable[string] `json:"framework,omitempty" yaml:"framework,omitempty" example:"example_value"` // The primary software development framework that the service uses. (Optional.)
Language *Nullable[string] `json:"language,omitempty" yaml:"language,omitempty" example:"example_value"` // The primary programming language that the service is written in. (Optional.)
LifecycleAlias *Nullable[string] `json:"lifecycleAlias,omitempty" yaml:"lifecycleAlias,omitempty" example:"example_value"` // The lifecycle stage of the service. (Optional.)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the service. (Required.)
OwnerAlias *Nullable[string] `json:"ownerAlias,omitempty" yaml:"ownerAlias,omitempty" example:"example_value"` // The team that owns the service. (Optional.)
OwnerInput *IdentifierInput `json:"ownerInput,omitempty" yaml:"ownerInput,omitempty"` // The owner for this service. (Optional.)
Parent *IdentifierInput `json:"parent,omitempty" yaml:"parent,omitempty"` // The parent system for the service. (Optional.)
Product *Nullable[string] `json:"product,omitempty" yaml:"product,omitempty" example:"example_value"` // A product is an application that your end user interacts with. Multiple services can work together to power a single product. (Optional.)
SkipAliasesValidation *Nullable[bool] `json:"skipAliasesValidation,omitempty" yaml:"skipAliasesValidation,omitempty" example:"false"` // Allows for the creation of a service with invalid aliases. (Optional.)
TierAlias *Nullable[string] `json:"tierAlias,omitempty" yaml:"tierAlias,omitempty" example:"example_value"` // The software tier that the service belongs to. (Optional.)
Type *IdentifierInput `json:"type,omitempty" yaml:"type,omitempty"` // The type of the component. (Optional.)
}
// ServiceDeleteInput specifies the input fields used in the `serviceDelete` mutation.
type ServiceDeleteInput struct {
Alias *Nullable[string] `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The alias of the service to be deleted. (Optional.)
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the service to be deleted. (Optional.)
}
// ServiceDependencyCreateInput specifies the input fields used for creating a service dependency.
type ServiceDependencyCreateInput struct {
DependencyKey ServiceDependencyKey `json:"dependencyKey" yaml:"dependencyKey"` // A source, destination pair specifying a dependency between services. (Required.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Notes for service dependency. (Optional.)
}
// ServiceDependencyKey represents a source, destination pair specifying a dependency between services.
type ServiceDependencyKey struct {
Destination *Nullable[ID] `json:"destination,omitempty" yaml:"destination,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the service that is depended upon. (Optional.)
DestinationIdentifier *IdentifierInput `json:"destinationIdentifier,omitempty" yaml:"destinationIdentifier,omitempty"` // The ID or alias identifier of the service that is depended upon. (Optional.)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Notes about the dependency edge (Optional.)
Source *Nullable[ID] `json:"source,omitempty" yaml:"source,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the service with the dependency. (Optional.)
SourceIdentifier *IdentifierInput `json:"sourceIdentifier,omitempty" yaml:"sourceIdentifier,omitempty"` // The ID or alias identifier of the service with the dependency. (Optional.)
}