Skip to content

Commit

Permalink
feat(api): OpenAPI spec update via Stainless API (#1860)
Browse files Browse the repository at this point in the history
  • Loading branch information
@stainless-app @stainless-bot
stainless-app[bot] authored and stainless-bot committed Apr 29, 2024
1 parent e6c29e9 commit 9e17133
Show file tree
Hide file tree
Showing 9 changed files with 2 additions and 754 deletions.
4 changes: 2 additions & 2 deletions .stats.yml
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 1266
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-c4098fcb3861719a0115fe0bd93ede436f466e42ea623f1ed1feeb1f126d9c3d.yml
configured_endpoints: 1259
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-eaeee7cb7327c83a8a9dca926a685e6e2aedc0f64ede2722f8a9004610dc8b3a.yml
26 changes: 0 additions & 26 deletions api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6673,36 +6673,10 @@ Methods:

# Snippets

Response Types:

- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#Snippet">Snippet</a>
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#SnippetDeleteResponseUnion">SnippetDeleteResponseUnion</a>

Methods:

- <code title="put /zones/{zone_identifier}/snippets/{snippet_name}">client.Snippets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#SnippetService.Update">Update</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, zoneIdentifier <a href="https://pkg.go.dev/builtin#string">string</a>, snippetName <a href="https://pkg.go.dev/builtin#string">string</a>, body <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#SnippetUpdateParams">SnippetUpdateParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#Snippet">Snippet</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
- <code title="get /zones/{zone_identifier}/snippets">client.Snippets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#SnippetService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, zoneIdentifier <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/internal/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/internal/pagination#SinglePage">SinglePage</a>[<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#Snippet">Snippet</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
- <code title="delete /zones/{zone_identifier}/snippets/{snippet_name}">client.Snippets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#SnippetService.Delete">Delete</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, zoneIdentifier <a href="https://pkg.go.dev/builtin#string">string</a>, snippetName <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#SnippetDeleteResponseUnion">SnippetDeleteResponseUnion</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
- <code title="get /zones/{zone_identifier}/snippets/{snippet_name}">client.Snippets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#SnippetService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, zoneIdentifier <a href="https://pkg.go.dev/builtin#string">string</a>, snippetName <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#Snippet">Snippet</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>

## Content

Methods:

- <code title="get /zones/{zone_identifier}/snippets/{snippet_name}/content">client.Snippets.Content.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#ContentService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, zoneIdentifier <a href="https://pkg.go.dev/builtin#string">string</a>, snippetName <a href="https://pkg.go.dev/builtin#string">string</a>) (http.Response, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>

## Rules

Response Types:

- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#RuleUpdateResponse">RuleUpdateResponse</a>
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#RuleListResponse">RuleListResponse</a>

Methods:

- <code title="put /zones/{zone_identifier}/snippets/snippet_rules">client.Snippets.Rules.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#RuleService.Update">Update</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, zoneIdentifier <a href="https://pkg.go.dev/builtin#string">string</a>, body <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#RuleUpdateParams">RuleUpdateParams</a>) ([]<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#RuleUpdateResponse">RuleUpdateResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
- <code title="get /zones/{zone_identifier}/snippets/snippet_rules">client.Snippets.Rules.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#RuleService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, zoneIdentifier <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/internal/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/internal/pagination#SinglePage">SinglePage</a>[<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets">snippets</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/snippets#RuleListResponse">RuleListResponse</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>

# Calls

Response Types:
Expand Down
1 change: 0 additions & 1 deletion shared/union.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,6 @@ func (UnionString) ImplementsOriginPostQuantumEncryptionOriginPostQuantumEncrypt
}
func (UnionString) ImplementsHostnamesSettingValueUnionParam() {}
func (UnionString) ImplementsHostnamesSettingValueUnion() {}
func (UnionString) ImplementsSnippetsSnippetDeleteResponseUnion() {}
func (UnionString) ImplementsCloudforceOneRequestDeleteResponseUnion() {}
func (UnionString) ImplementsCloudforceOneRequestMessageDeleteResponseUnion() {}
func (UnionString) ImplementsCloudforceOneRequestPriorityDeleteResponseUnion() {}
Expand Down
14 changes: 0 additions & 14 deletions snippets/content.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
package snippets

import (
"context"
"fmt"
"net/http"

"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
)

Expand All @@ -27,12 +22,3 @@ func NewContentService(opts ...option.RequestOption) (r *ContentService) {
r.Options = opts
return
}

// Snippet Content
func (r *ContentService) Get(ctx context.Context, zoneIdentifier string, snippetName string, opts ...option.RequestOption) (res *http.Response, err error) {
opts = append(r.Options[:], opts...)
opts = append([]option.RequestOption{option.WithHeader("Accept", "multipart/form-data")}, opts...)
path := fmt.Sprintf("zones/%s/snippets/%s/content", zoneIdentifier, snippetName)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
return
}
56 changes: 0 additions & 56 deletions snippets/content_test.go
View file

This file was deleted.

166 changes: 0 additions & 166 deletions snippets/rule.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,7 @@
package snippets

import (
"context"
"fmt"
"net/http"

"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/pagination"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
"github.com/cloudflare/cloudflare-go/v2/shared"
)

// RuleService contains methods and other services that help with interacting with
Expand All @@ -31,160 +22,3 @@ func NewRuleService(opts ...option.RequestOption) (r *RuleService) {
r.Options = opts
return
}

// Put Rules
func (r *RuleService) Update(ctx context.Context, zoneIdentifier string, body RuleUpdateParams, opts ...option.RequestOption) (res *[]RuleUpdateResponse, err error) {
opts = append(r.Options[:], opts...)
var env RuleUpdateResponseEnvelope
path := fmt.Sprintf("zones/%s/snippets/snippet_rules", zoneIdentifier)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPut, path, body, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}

// Rules
func (r *RuleService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], err error) {
var raw *http.Response
opts = append(r.Options, opts...)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := fmt.Sprintf("zones/%s/snippets/snippet_rules", zoneIdentifier)
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, nil, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}

// Rules
func (r *RuleService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse] {
return pagination.NewSinglePageAutoPager(r.List(ctx, zoneIdentifier, opts...))
}

type RuleUpdateResponse struct {
Description string `json:"description"`
Enabled bool `json:"enabled"`
Expression string `json:"expression"`
// Snippet identifying name
SnippetName string `json:"snippet_name"`
JSON ruleUpdateResponseJSON `json:"-"`
}

// ruleUpdateResponseJSON contains the JSON metadata for the struct
// [RuleUpdateResponse]
type ruleUpdateResponseJSON struct {
Description apijson.Field
Enabled apijson.Field
Expression apijson.Field
SnippetName apijson.Field
raw string
ExtraFields map[string]apijson.Field
}

func (r *RuleUpdateResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}

func (r ruleUpdateResponseJSON) RawJSON() string {
return r.raw
}

type RuleListResponse struct {
Description string `json:"description"`
Enabled bool `json:"enabled"`
Expression string `json:"expression"`
// Snippet identifying name
SnippetName string `json:"snippet_name"`
JSON ruleListResponseJSON `json:"-"`
}

// ruleListResponseJSON contains the JSON metadata for the struct
// [RuleListResponse]
type ruleListResponseJSON struct {
Description apijson.Field
Enabled apijson.Field
Expression apijson.Field
SnippetName apijson.Field
raw string
ExtraFields map[string]apijson.Field
}

func (r *RuleListResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}

func (r ruleListResponseJSON) RawJSON() string {
return r.raw
}

type RuleUpdateParams struct {
// List of snippet rules
Rules param.Field[[]RuleUpdateParamsRule] `json:"rules"`
}

func (r RuleUpdateParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}

type RuleUpdateParamsRule struct {
Description param.Field[string] `json:"description"`
Enabled param.Field[bool] `json:"enabled"`
Expression param.Field[string] `json:"expression"`
// Snippet identifying name
SnippetName param.Field[string] `json:"snippet_name"`
}

func (r RuleUpdateParamsRule) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}

type RuleUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// List of snippet rules
Result []RuleUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success RuleUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON ruleUpdateResponseEnvelopeJSON `json:"-"`
}

// ruleUpdateResponseEnvelopeJSON contains the JSON metadata for the struct
// [RuleUpdateResponseEnvelope]
type ruleUpdateResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}

func (r *RuleUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}

func (r ruleUpdateResponseEnvelopeJSON) RawJSON() string {
return r.raw
}

// Whether the API call was successful
type RuleUpdateResponseEnvelopeSuccess bool

const (
RuleUpdateResponseEnvelopeSuccessTrue RuleUpdateResponseEnvelopeSuccess = true
)

func (r RuleUpdateResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case RuleUpdateResponseEnvelopeSuccessTrue:
return true
}
return false
}
84 changes: 0 additions & 84 deletions snippets/rule_test.go
View file

This file was deleted.

0 comments on commit 9e17133

Please sign in to comment.