Skip to content

Commit e9d8f3b

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Mark restricted_roles as deprecated (#3609)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent ba3af12 commit e9d8f3b

7 files changed

Lines changed: 31 additions & 7 deletions

.generator/schemas/v1/openapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17642,8 +17642,10 @@ components:
1764217642
type: string
1764317643
type: object
1764417644
SyntheticsRestrictedRoles:
17645+
deprecated: true
1764517646
description: A list of role identifiers that can be pulled from the Roles API,
17646-
for restricting read and write access.
17647+
for restricting read and write access. This field is deprecated. Use the restriction
17648+
policies API to manage permissions.
1764717649
example:
1764817650
- xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
1764917651
items:

.generator/schemas/v2/openapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58070,8 +58070,10 @@ components:
5807058070
type: string
5807158071
type: object
5807258072
SyntheticsRestrictedRoles:
58073+
deprecated: true
5807358074
description: A list of role identifiers that can be pulled from the Roles API,
58074-
for restricting read and write access.
58075+
for restricting read and write access. This field is deprecated. Use the restriction
58076+
policies API to manage permissions.
5807558077
example:
5807658078
- xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
5807758079
items:

api/datadogV1/model_synthetics_global_variable_attributes.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ import (
1010

1111
// SyntheticsGlobalVariableAttributes Attributes of the global variable.
1212
type SyntheticsGlobalVariableAttributes struct {
13-
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
13+
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
14+
// Deprecated
1415
RestrictedRoles []string `json:"restricted_roles,omitempty"`
1516
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1617
UnparsedObject map[string]interface{} `json:"-"`
@@ -35,6 +36,7 @@ func NewSyntheticsGlobalVariableAttributesWithDefaults() *SyntheticsGlobalVariab
3536
}
3637

3738
// GetRestrictedRoles returns the RestrictedRoles field value if set, zero value otherwise.
39+
// Deprecated
3840
func (o *SyntheticsGlobalVariableAttributes) GetRestrictedRoles() []string {
3941
if o == nil || o.RestrictedRoles == nil {
4042
var ret []string
@@ -45,6 +47,7 @@ func (o *SyntheticsGlobalVariableAttributes) GetRestrictedRoles() []string {
4547

4648
// GetRestrictedRolesOk returns a tuple with the RestrictedRoles field value if set, nil otherwise
4749
// and a boolean to check if the value has been set.
50+
// Deprecated
4851
func (o *SyntheticsGlobalVariableAttributes) GetRestrictedRolesOk() (*[]string, bool) {
4952
if o == nil || o.RestrictedRoles == nil {
5053
return nil, false
@@ -58,6 +61,7 @@ func (o *SyntheticsGlobalVariableAttributes) HasRestrictedRoles() bool {
5861
}
5962

6063
// SetRestrictedRoles gets a reference to the given []string and assigns it to the RestrictedRoles field.
64+
// Deprecated
6165
func (o *SyntheticsGlobalVariableAttributes) SetRestrictedRoles(v []string) {
6266
o.RestrictedRoles = v
6367
}

api/datadogV1/model_synthetics_mobile_test_options.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ type SyntheticsMobileTestOptions struct {
3737
MonitorPriority *int32 `json:"monitor_priority,omitempty"`
3838
// A boolean set to not take a screenshot for the step.
3939
NoScreenshot *bool `json:"noScreenshot,omitempty"`
40-
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
40+
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
41+
// Deprecated
4142
RestrictedRoles []string `json:"restricted_roles,omitempty"`
4243
// Object describing the retry strategy to apply to a Synthetic test.
4344
Retry *SyntheticsTestOptionsRetry `json:"retry,omitempty"`
@@ -399,6 +400,7 @@ func (o *SyntheticsMobileTestOptions) SetNoScreenshot(v bool) {
399400
}
400401

401402
// GetRestrictedRoles returns the RestrictedRoles field value if set, zero value otherwise.
403+
// Deprecated
402404
func (o *SyntheticsMobileTestOptions) GetRestrictedRoles() []string {
403405
if o == nil || o.RestrictedRoles == nil {
404406
var ret []string
@@ -409,6 +411,7 @@ func (o *SyntheticsMobileTestOptions) GetRestrictedRoles() []string {
409411

410412
// GetRestrictedRolesOk returns a tuple with the RestrictedRoles field value if set, nil otherwise
411413
// and a boolean to check if the value has been set.
414+
// Deprecated
412415
func (o *SyntheticsMobileTestOptions) GetRestrictedRolesOk() (*[]string, bool) {
413416
if o == nil || o.RestrictedRoles == nil {
414417
return nil, false
@@ -422,6 +425,7 @@ func (o *SyntheticsMobileTestOptions) HasRestrictedRoles() bool {
422425
}
423426

424427
// SetRestrictedRoles gets a reference to the given []string and assigns it to the RestrictedRoles field.
428+
// Deprecated
425429
func (o *SyntheticsMobileTestOptions) SetRestrictedRoles(v []string) {
426430
o.RestrictedRoles = v
427431
}

api/datadogV1/model_synthetics_private_location_metadata.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ import (
1010

1111
// SyntheticsPrivateLocationMetadata Object containing metadata about the private location.
1212
type SyntheticsPrivateLocationMetadata struct {
13-
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
13+
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
14+
// Deprecated
1415
RestrictedRoles []string `json:"restricted_roles,omitempty"`
1516
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1617
UnparsedObject map[string]interface{} `json:"-"`
@@ -35,6 +36,7 @@ func NewSyntheticsPrivateLocationMetadataWithDefaults() *SyntheticsPrivateLocati
3536
}
3637

3738
// GetRestrictedRoles returns the RestrictedRoles field value if set, zero value otherwise.
39+
// Deprecated
3840
func (o *SyntheticsPrivateLocationMetadata) GetRestrictedRoles() []string {
3941
if o == nil || o.RestrictedRoles == nil {
4042
var ret []string
@@ -45,6 +47,7 @@ func (o *SyntheticsPrivateLocationMetadata) GetRestrictedRoles() []string {
4547

4648
// GetRestrictedRolesOk returns a tuple with the RestrictedRoles field value if set, nil otherwise
4749
// and a boolean to check if the value has been set.
50+
// Deprecated
4851
func (o *SyntheticsPrivateLocationMetadata) GetRestrictedRolesOk() (*[]string, bool) {
4952
if o == nil || o.RestrictedRoles == nil {
5053
return nil, false
@@ -58,6 +61,7 @@ func (o *SyntheticsPrivateLocationMetadata) HasRestrictedRoles() bool {
5861
}
5962

6063
// SetRestrictedRoles gets a reference to the given []string and assigns it to the RestrictedRoles field.
64+
// Deprecated
6165
func (o *SyntheticsPrivateLocationMetadata) SetRestrictedRoles(v []string) {
6266
o.RestrictedRoles = v
6367
}

api/datadogV1/model_synthetics_test_options.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ type SyntheticsTestOptions struct {
5656
MonitorPriority *int32 `json:"monitor_priority,omitempty"`
5757
// Prevents saving screenshots of the steps.
5858
NoScreenshot *bool `json:"noScreenshot,omitempty"`
59-
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
59+
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
60+
// Deprecated
6061
RestrictedRoles []string `json:"restricted_roles,omitempty"`
6162
// Object describing the retry strategy to apply to a Synthetic test.
6263
Retry *SyntheticsTestOptionsRetry `json:"retry,omitempty"`
@@ -690,6 +691,7 @@ func (o *SyntheticsTestOptions) SetNoScreenshot(v bool) {
690691
}
691692

692693
// GetRestrictedRoles returns the RestrictedRoles field value if set, zero value otherwise.
694+
// Deprecated
693695
func (o *SyntheticsTestOptions) GetRestrictedRoles() []string {
694696
if o == nil || o.RestrictedRoles == nil {
695697
var ret []string
@@ -700,6 +702,7 @@ func (o *SyntheticsTestOptions) GetRestrictedRoles() []string {
700702

701703
// GetRestrictedRolesOk returns a tuple with the RestrictedRoles field value if set, nil otherwise
702704
// and a boolean to check if the value has been set.
705+
// Deprecated
703706
func (o *SyntheticsTestOptions) GetRestrictedRolesOk() (*[]string, bool) {
704707
if o == nil || o.RestrictedRoles == nil {
705708
return nil, false
@@ -713,6 +716,7 @@ func (o *SyntheticsTestOptions) HasRestrictedRoles() bool {
713716
}
714717

715718
// SetRestrictedRoles gets a reference to the given []string and assigns it to the RestrictedRoles field.
719+
// Deprecated
716720
func (o *SyntheticsTestOptions) SetRestrictedRoles(v []string) {
717721
o.RestrictedRoles = v
718722
}

api/datadogV2/model_synthetics_global_variable_attributes.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ import (
1010

1111
// SyntheticsGlobalVariableAttributes Attributes of the global variable.
1212
type SyntheticsGlobalVariableAttributes struct {
13-
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
13+
// A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
14+
// Deprecated
1415
RestrictedRoles []string `json:"restricted_roles,omitempty"`
1516
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1617
UnparsedObject map[string]interface{} `json:"-"`
@@ -35,6 +36,7 @@ func NewSyntheticsGlobalVariableAttributesWithDefaults() *SyntheticsGlobalVariab
3536
}
3637

3738
// GetRestrictedRoles returns the RestrictedRoles field value if set, zero value otherwise.
39+
// Deprecated
3840
func (o *SyntheticsGlobalVariableAttributes) GetRestrictedRoles() []string {
3941
if o == nil || o.RestrictedRoles == nil {
4042
var ret []string
@@ -45,6 +47,7 @@ func (o *SyntheticsGlobalVariableAttributes) GetRestrictedRoles() []string {
4547

4648
// GetRestrictedRolesOk returns a tuple with the RestrictedRoles field value if set, nil otherwise
4749
// and a boolean to check if the value has been set.
50+
// Deprecated
4851
func (o *SyntheticsGlobalVariableAttributes) GetRestrictedRolesOk() (*[]string, bool) {
4952
if o == nil || o.RestrictedRoles == nil {
5053
return nil, false
@@ -58,6 +61,7 @@ func (o *SyntheticsGlobalVariableAttributes) HasRestrictedRoles() bool {
5861
}
5962

6063
// SetRestrictedRoles gets a reference to the given []string and assigns it to the RestrictedRoles field.
64+
// Deprecated
6165
func (o *SyntheticsGlobalVariableAttributes) SetRestrictedRoles(v []string) {
6266
o.RestrictedRoles = v
6367
}

0 commit comments

Comments
 (0)