Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove some internal details for Rulesets API #1346

Merged
merged 3 commits into from
Aug 1, 2023
Merged

Remove some internal details for Rulesets API #1346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8db7a4
Update API reference links for Rulesets API endpoints
zakcutner Aug 1, 2023
89d0efc
Remove "schema" ruleset kind
zakcutner Aug 1, 2023
f610edd
Update request parameters for Ruleset API
zakcutner Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changelog/1346.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
```release-note:enhancement
rulesets: Update API reference links
```

```release-note:enhancement
rulesets: Remove internal-only schema kind
```

```release-note:enhancement
rulesets: Remove some request parameters that are not allowed or have no effect
```
54 changes: 27 additions & 27 deletions rulesets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ const (
RulesetKindCustom RulesetKind = "custom"
RulesetKindManaged RulesetKind = "managed"
RulesetKindRoot RulesetKind = "root"
RulesetKindSchema RulesetKind = "schema"
RulesetKindZone RulesetKind = "zone"

RulesetPhaseDDoSL4 RulesetPhase = "ddos_l4"
Expand Down Expand Up @@ -85,7 +84,6 @@ func RulesetKindValues() []string {
string(RulesetKindCustom),
string(RulesetKindManaged),
string(RulesetKindRoot),
string(RulesetKindSchema),
string(RulesetKindZone),
}
}
Expand Down Expand Up @@ -718,13 +716,11 @@ type UpdateRulesetResponse struct {
type ListRulesetsParams struct{}

type CreateRulesetParams struct {
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
Kind string `json:"kind,omitempty"`
Version *string `json:"version,omitempty"`
Phase string `json:"phase,omitempty"`
Rules []RulesetRule `json:"rules"`
ShareableEntitlementName string `json:"shareable_entitlement_name,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
Kind string `json:"kind,omitempty"`
Phase string `json:"phase,omitempty"`
Rules []RulesetRule `json:"rules"`
}

type UpdateRulesetParams struct {
Expand All @@ -734,19 +730,16 @@ type UpdateRulesetParams struct {
}

type UpdateEntrypointRulesetParams struct {
Name string `json:"name,omitempty"`
Copy link
Contributor Author

@zakcutner zakcutner Aug 1, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This technically can be useful to specify but has some slightly inconsistent behaviour from the API if it is. If you specify it and the entry point ruleset didn't exist before, then this name will be used. If the entry point ruleset already exists though, this name will be ignored (and the ruleset will not be renamed).

Omitting the name always works consistently and will cause the API to set it to "default" if an entry point ruleset does not already exist. This is why I think it's probably best to not allow users to set the name explicitly to avoid confusion, but we can keep it here if that would be too much of a breaking change. What do you think @jacobbednarz?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works for me!

Description string `json:"description,omitempty"`
Kind string `json:"kind,omitempty"`
Version *string `json:"version,omitempty"`
Phase string `json:"-"`
Description string `json:"description,omitempty"`
Rules []RulesetRule `json:"rules"`
}

// ListRulesets lists all Rulesets for a given zone or account depending on the
// ListRulesets lists all Rulesets in a given zone or account depending on the
// ResourceContainer type provided.
//
// API reference: https://api.cloudflare.com/#zone-rulesets-list-zone-rulesets
// API reference: https://api.cloudflare.com/#account-rulesets-list-account-rulesets
// API reference: https://developers.cloudflare.com/api/operations/listAccountRulesets
// API reference: https://developers.cloudflare.com/api/operations/listZoneRulesets
func (api *API) ListRulesets(ctx context.Context, rc *ResourceContainer, params ListRulesetsParams) ([]Ruleset, error) {
uri := fmt.Sprintf("/%s/%s/rulesets", rc.Level, rc.Identifier)

Expand All @@ -765,8 +758,8 @@ func (api *API) ListRulesets(ctx context.Context, rc *ResourceContainer, params

// GetRuleset fetches a single ruleset.
//
// API reference: https://api.cloudflare.com/#zone-rulesets-get-a-zone-ruleset
// API reference: https://api.cloudflare.com/#account-rulesets-get-an-account-ruleset
// API reference: https://developers.cloudflare.com/api/operations/getAccountRuleset
// API reference: https://developers.cloudflare.com/api/operations/getZoneRuleset
func (api *API) GetRuleset(ctx context.Context, rc *ResourceContainer, rulesetID string) (Ruleset, error) {
uri := fmt.Sprintf("/%s/%s/rulesets/%s", rc.Level, rc.Identifier, rulesetID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
Expand All @@ -782,10 +775,10 @@ func (api *API) GetRuleset(ctx context.Context, rc *ResourceContainer, rulesetID
return result.Result, nil
}

// CreateRuleset initialises a new ruleset.
// CreateRuleset creates a new ruleset.
//
// API reference: https://api.cloudflare.com/#zone-rulesets-create-zone-ruleset
// API reference: https://api.cloudflare.com/#account-rulesets-create-account-ruleset
// API reference: https://developers.cloudflare.com/api/operations/createAccountRuleset
// API reference: https://developers.cloudflare.com/api/operations/createZoneRuleset
func (api *API) CreateRuleset(ctx context.Context, rc *ResourceContainer, params CreateRulesetParams) (Ruleset, error) {
uri := fmt.Sprintf("/%s/%s/rulesets", rc.Level, rc.Identifier)
res, err := api.makeRequestContext(ctx, http.MethodPost, uri, params)
Expand All @@ -803,8 +796,8 @@ func (api *API) CreateRuleset(ctx context.Context, rc *ResourceContainer, params

// DeleteRuleset removes a ruleset based on the ruleset ID.
//
// API reference: https://api.cloudflare.com/#zone-rulesets-delete-zone-ruleset
// API reference: https://api.cloudflare.com/#account-rulesets-delete-account-ruleset
// API reference: https://developers.cloudflare.com/api/operations/deleteAccountRuleset
// API reference: https://developers.cloudflare.com/api/operations/deleteZoneRuleset
func (api *API) DeleteRuleset(ctx context.Context, rc *ResourceContainer, rulesetID string) error {
uri := fmt.Sprintf("/%s/%s/rulesets/%s", rc.Level, rc.Identifier, rulesetID)
res, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
Expand All @@ -824,8 +817,8 @@ func (api *API) DeleteRuleset(ctx context.Context, rc *ResourceContainer, rulese

// UpdateRuleset updates a ruleset based on the ruleset ID.
//
// API reference: https://api.cloudflare.com/#zone-rulesets-update-a-zone-ruleset
// API reference: https://api.cloudflare.com/#account-rulesets-update-account-ruleset
// API reference: https://developers.cloudflare.com/api/operations/updateAccountRuleset
// API reference: https://developers.cloudflare.com/api/operations/updateZoneRuleset
func (api *API) UpdateRuleset(ctx context.Context, rc *ResourceContainer, params UpdateRulesetParams) (Ruleset, error) {
if params.ID == "" {
return Ruleset{}, ErrMissingResourceIdentifier
Expand All @@ -845,7 +838,10 @@ func (api *API) UpdateRuleset(ctx context.Context, rc *ResourceContainer, params
return result.Result, nil
}

// GetEntrypointRuleset returns a ruleset phase based on the resource entrypoint.
// GetEntrypointRuleset returns an entry point ruleset base on the phase.
//
// API reference: https://developers.cloudflare.com/api/operations/getAccountEntrypointRuleset
// API reference: https://developers.cloudflare.com/api/operations/getZoneEntrypointRuleset
func (api *API) GetEntrypointRuleset(ctx context.Context, rc *ResourceContainer, phase string) (Ruleset, error) {
uri := fmt.Sprintf("/%s/%s/rulesets/phases/%s/entrypoint", rc.Level, rc.Identifier, phase)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
Expand All @@ -861,7 +857,11 @@ func (api *API) GetEntrypointRuleset(ctx context.Context, rc *ResourceContainer,
return result.Result, nil
}

// UpdateEntrypointRuleset updates a ruleset phase based on the entrypoint.
// UpdateEntrypointRuleset updates an entry point ruleset phase based on the
// phase.
//
// API reference: https://developers.cloudflare.com/api/operations/updateAccountEntrypointRuleset
// API reference: https://developers.cloudflare.com/api/operations/updateZoneEntrypointRuleset
func (api *API) UpdateEntrypointRuleset(ctx context.Context, rc *ResourceContainer, params UpdateEntrypointRulesetParams) (Ruleset, error) {
if params.Phase == "" {
return Ruleset{}, ErrMissingRulesetPhase
Expand Down