naumanali

README

github.com/speakeasy-sdks/naumanali

SDK Installation

go get github.com/speakeasy-sdks/naumanali

SDK Example Usage

package main

import (
	"context"
	"github.com/speakeasy-sdks/naumanali"
	"github.com/speakeasy-sdks/naumanali/pkg/models/operations"
	"github.com/speakeasy-sdks/naumanali/pkg/models/shared"
	"log"
)

func main() {
	s := naumanali.New(
		naumanali.WithSecurity(""),
	)

	ctx := context.Background()
	res, err := s.Apitest.ExportFileByBranch(ctx, operations.ExportFileByBranchRequest{
		StoplightVersion: operations.ExportFileByBranchStoplightVersionStoplightAPIVersionStringTwoThousandAndTwentyTwo1205.ToPointer(),
		BranchName:       "string",
		FilePath:         "/etc/namedb/radian_southeast.csp",
		ProjectID:        "string",
	})
	if err != nil {
		log.Fatal(err)
	}

	if res.ExportFileByBranch200ApplicationJSONAny != nil {
		// handle response
	}
}

Available Resources and Operations

Apitest SDK

• ExportFileByBranch - exportFileByBranch
• ExportFileByCommit - exportFileByCommit

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Documentation

Index

• Variables
• func Bool(b bool) *bool
• func Float32(f float32) *float32
• func Float64(f float64) *float64
• func Int(i int) *int
• func Int64(i int64) *int64
• func String(s string) *string
• type Apitest
  • func New(opts ...SDKOption) *Apitest
  • func (s *Apitest) ExportFileByBranch(ctx context.Context, request operations.ExportFileByBranchRequest, ...) (*operations.ExportFileByBranchResponse, error)
  • func (s *Apitest) ExportFileByCommit(ctx context.Context, request operations.ExportFileByCommitRequest, ...) (*operations.ExportFileByCommitResponse, error)
• type HTTPClient
• type SDKOption
  • func WithClient(client HTTPClient) SDKOption
  • func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
  • func WithSecurity(authorization string) SDKOption
  • func WithServerIndex(serverIndex int) SDKOption
  • func WithServerURL(serverURL string) SDKOption
  • func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

Variables

var ServerList = []string{
	"https://api.stoplight.io",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type Apitest

type Apitest struct {
	// contains filtered or unexported fields
}

Apitest - Stoplight Catalog API: The Catalog API provides [bundled exports](https://docs.stoplight.io/docs/platform/37d160068e33c-export-api-files#ref-options) of your OpenAPI and JSON Schema files. A bundled export resolves remote `$refs` once, and then reuses references to the same objects to avoid repetition and produce a cleaner file.

Use Catalog API exports to:

- Facilitate automated testing - Update internal API Directories - Update a locally hosted [Prism mock server](https://github.com/stoplightio/prism) - Avoid direct Git access

func New

func New(opts ...SDKOption) *Apitest

New creates a new instance of the SDK with the provided options

func (*Apitest) ExportFileByBranch

func (s *Apitest) ExportFileByBranch(ctx context.Context, request operations.ExportFileByBranchRequest, opts ...operations.Option) (*operations.ExportFileByBranchResponse, error)

ExportFileByBranch - exportFileByBranch Exports an OpenAPI or JSON Schema file from a Stoplight project that exists on the specified branch.

func (*Apitest) ExportFileByCommit

func (s *Apitest) ExportFileByCommit(ctx context.Context, request operations.ExportFileByCommitRequest, opts ...operations.Option) (*operations.ExportFileByCommitResponse, error)

ExportFileByCommit - exportFileByCommit Exports an OpenAPI or JSON Schema file from a Stoplight project that exists on the specified commit.

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type SDKOption

type SDKOption func(*Apitest)

func WithClient

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithSecurity

func WithSecurity(authorization string) SDKOption

func WithServerIndex

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters