GATE-1703 team rules + accounts + config api #693

rexscaria · 2021-08-10T14:53:16Z

The pr has newly publicized Teams api for rules + account config

Description

This is the new teams rules api.

Has your change been tested?

Explain how the change has been tested and what you ran to confirm your
change affects other parts of the code. Automated tests are generally
expected and changes without tests should explain why they aren't
required.

Types of changes

Mew features- Teams rules + accounts api

teams_accounts.go

teams_rules.go

teams_accounts.go

jacobbednarz · 2021-08-15T21:55:37Z

teams_accounts.go

+	GatewayID    string `json:"gateway_tag"`   // Internal teams ID
+	ProviderName string `json:"provider_name"` // Auth provider
+	CloudflareID string `json:"id"`            // cloudflare account ID


Suggested change

GatewayID string `json:"gateway_tag"` // Internal teams ID

ProviderName string `json:"provider_name"` // Auth provider

CloudflareID string `json:"id"` // cloudflare account ID

GatewayTag string `json:"gateway_tag"` // Internal teams ID

ProviderName string `json:"provider_name"` // Auth provider

ID string `json:"id"` // cloudflare account ID

is there a reason the struct field is different to the JSON tag? generally we've used a 1:1 for simplicity and reduce confusion between the API and the SDK counterpart.

Yeah. I changed the variable names to give a little more readability to the user. The original struct json tags we use in the API are confusing.

i agree it can be confusing here, but i think we need to go one way or another as right now it's in limbo and hard to grok if you don't know the reasoning. i think we should rename the fields to match the JSON to avoid further confusion especially seeing how the API docs reference the JSON tags.

teams_rules.go

jacobbednarz · 2021-08-15T21:56:36Z

teams_rules.go

+	BISOAdminControls *TeamsBISOAdminControlSettings `json:"biso_admin_controls"`
+}
+
+// TeamsL4OverrideSettings : only used in l4 filter type rule with action set to override


Suggested change

// TeamsL4OverrideSettings : only used in l4 filter type rule with action set to override

// TeamsL4OverrideSettings used in l4 filter type rule with action set to override.

teams_rules.go

rexscaria · 2021-08-16T17:54:33Z

@jacobbednarz : i have resolved all the comments. Thanks

jacobbednarz · 2021-08-16T21:51:18Z

teams_rules.go

+	UUID        string             `json:"id"`
+	Name        string             `json:"name"`
+	Description string             `json:"description"`
+	Precedence  uint64             `json:"precedence"`
+	Enabled     bool               `json:"enabled"`
+	Action      TeamsGatewayAction `json:"action"`
+	Settings    TeamsRuleSettings  `json:"rule_settings,omitempty"`


Suggested change

UUID string `json:"id"`

Name string `json:"name"`

Description string `json:"description"`

Precedence uint64 `json:"precedence"`

Enabled bool `json:"enabled"`

Action TeamsGatewayAction `json:"action"`

Settings TeamsRuleSettings `json:"rule_settings,omitempty"`

ID string `json:"id"`

Name string `json:"name"`

Description string `json:"description"`

Precedence uint64 `json:"precedence"`

Enabled bool `json:"enabled"`

Action TeamsGatewayAction `json:"action"`

RuleSettings TeamsRuleSettings `json:"rule_settings,omitempty"`

these should also match the JSON tag names

jacobbednarz · 2021-08-16T21:53:33Z

teams_rules.go

+	Traffic     string             `json:"traffic"`
+	Identity    string             `json:"identity"`
+	Version     uint64             `json:"version"`
+	Settings    TeamsRuleSettings  `json:"rule_settings,omitempty"`


Suggested change

Settings TeamsRuleSettings `json:"rule_settings,omitempty"`

RuleSettings TeamsRuleSettings `json:"rule_settings,omitempty"`

jacobbednarz · 2021-08-16T21:59:48Z

teams_rules.go

+//
+// API reference: https://api.cloudflare.com/#teams-rules-properties
+func (api *API) TeamsRule(ctx context.Context, accountID string, ruleId string, ) (TeamsRule, error) {
+	uri := fmt.Sprintf("/accounts/%s/gateway/rules/%s", accountID, ruleId)


looking between the API and this PR, we've got a difference in how the rule ID is stored and retrieved.

in the API (the RESTful route), we want a hash style value, however on the resource itself it is a UUIDv4 value. this is very confusing and will make handling this in Terraform/cf-terraforming very painful as the identifier is used as an anchor for subsequent API calls. ideally, we decide on one and continue with it to avoid extra work going forward.

Turns we have new change in api, that accepts uuid with dashes. I have updated the comment. Resolving this.

rexscaria · 2021-08-17T19:50:58Z

I have made all the json tags match variable names.

jacobbednarz · 2021-08-18T23:07:07Z

thanks @rexscaria, this is awesome! when the public documentation links are available we can get those updated.

Michael9127 mentioned this pull request Aug 10, 2021

GATE-1848: Adds support for gateway location API cloudflare/terraform-provider-cloudflare#1154

Merged

rexscaria force-pushed the rex/GATE-1703-teams-api branch 2 times, most recently from 8e4262e to f469f4a Compare August 10, 2021 22:19

Michael9127 reviewed Aug 12, 2021

View reviewed changes

teams_accounts.go Show resolved Hide resolved

teams_rules.go Outdated Show resolved Hide resolved

rexscaria force-pushed the rex/GATE-1703-teams-api branch 2 times, most recently from f703fff to 1f82abf Compare August 12, 2021 14:56

Michael9127 reviewed Aug 13, 2021

View reviewed changes

teams_rules.go Outdated Show resolved Hide resolved

jacobbednarz reviewed Aug 15, 2021

View reviewed changes

teams_accounts.go Outdated Show resolved Hide resolved

jacobbednarz reviewed Aug 15, 2021

View reviewed changes

teams_accounts.go Outdated Show resolved Hide resolved

jacobbednarz reviewed Aug 15, 2021

View reviewed changes

teams_rules.go Outdated Show resolved Hide resolved

jacobbednarz reviewed Aug 15, 2021

View reviewed changes

teams_rules.go Show resolved Hide resolved

rexscaria force-pushed the rex/GATE-1703-teams-api branch 2 times, most recently from f92e554 to 5cb6d3e Compare August 16, 2021 17:54

jacobbednarz reviewed Aug 16, 2021

View reviewed changes

rexscaria force-pushed the rex/GATE-1703-teams-api branch from 5cb6d3e to cc8a68b Compare August 17, 2021 19:50

GATE-1703 team rules + accounts + config api

03129da

rexscaria force-pushed the rex/GATE-1703-teams-api branch from cc8a68b to 03129da Compare August 17, 2021 19:52

whitespace and documentation link updates

44b952d

jacobbednarz force-pushed the rex/GATE-1703-teams-api branch from 28995eb to 44b952d Compare August 18, 2021 22:55

jacobbednarz merged commit c26ab13 into cloudflare:master Aug 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GATE-1703 team rules + accounts + config api #693

GATE-1703 team rules + accounts + config api #693

rexscaria commented Aug 10, 2021

jacobbednarz Aug 15, 2021

rexscaria Aug 16, 2021

jacobbednarz Aug 16, 2021

jacobbednarz Aug 15, 2021

rexscaria Aug 16, 2021

rexscaria commented Aug 16, 2021

jacobbednarz Aug 16, 2021

jacobbednarz Aug 16, 2021

jacobbednarz Aug 16, 2021

rexscaria Aug 17, 2021

rexscaria commented Aug 17, 2021

jacobbednarz commented Aug 18, 2021

	// TeamsL4OverrideSettings : only used in l4 filter type rule with action set to override
	// TeamsL4OverrideSettings used in l4 filter type rule with action set to override.

	Settings TeamsRuleSettings `json:"rule_settings,omitempty"`
	RuleSettings TeamsRuleSettings `json:"rule_settings,omitempty"`

GATE-1703 team rules + accounts + config api #693

GATE-1703 team rules + accounts + config api #693

Conversation

rexscaria commented Aug 10, 2021

Description

Has your change been tested?

Types of changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rexscaria commented Aug 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rexscaria commented Aug 17, 2021

jacobbednarz commented Aug 18, 2021