petstore

package

v3.0.64+incompatible Latest Latest Go to latest Published: Nov 7, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/swagger-api/swagger-codegen

Links

Open Source Insights

README ¶

Go API client for petstore

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./petstore"

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io:80/v2

Class	Method	HTTP request	Description
AnimalApi	AddAnimal	Post /animal	Add a new animal to the store
AnimalApi	DeleteAnimal	Delete /animal/{animalId}	Deletes a animal
AnimalApi	GetAnimalById	Get /animal/{animalId}	Find animal by ID
AnimalApi	UpdateAnimal	Put /animal	Update an existing animal
AnimalApi	UpdateAnimalWithForm	Post /animal/{animalId}	Updates a animal
AnotherFakeApi	TestSpecialTags	Patch /another-fake/dummy	To test special tags
DogApi	AddDog	Post /dog	Add a new dog to the store
DogApi	DeleteDog	Delete /dog/{dogId}	Deletes a dog
DogApi	GetDogById	Get /dog/{dogId}	Find dog by ID
DogApi	UpdateDog	Put /dog	Update an existing dog
DogApi	UpdateDogWithForm	Post /dog/{dogId}	Updates a dog
FakeApi	FakeOuterBooleanSerialize	Post /fake/outer/boolean
FakeApi	FakeOuterCompositeSerialize	Post /fake/outer/composite
FakeApi	FakeOuterNumberSerialize	Post /fake/outer/number
FakeApi	FakeOuterStringSerialize	Post /fake/outer/string
FakeApi	TestClientModel	Patch /fake	To test "client" model
FakeApi	TestEndpointParameters	Post /fake	Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트
FakeApi	TestEnumParameters	Get /fake	To test enum parameters
FakeApi	TestEnumRequestBody	Post /fake/enum/form	To test enum parameters
FakeApi	TestInlineAdditionalProperties	Post /fake/inline-additionalProperties	test inline additionalProperties
FakeApi	TestJsonFormData	Post /fake/jsonFormData	test json serialization of form data
FakeClassnameTags123Api	TestClassname	Patch /fake_classname_test	To test class name in snake case
PetApi	AddPet	Post /pet	Add a new pet to the store
PetApi	DeletePet	Delete /pet/{petId}	Deletes a pet
PetApi	DoCategoryStuff	Post /pet/category
PetApi	FindPetsByStatus	Get /pet/findByStatus	Finds Pets by status
PetApi	FindPetsByTags	Get /pet/findByTags	Finds Pets by tags
PetApi	GetAllPets	Get /allPets
PetApi	GetPetById	Get /pet/{petId}	Find pet by ID
PetApi	GetRandomPet	Get /randomPet
PetApi	UpdatePet	Put /pet	Update an existing pet
PetApi	UpdatePetWithForm	Post /pet/{petId}	Updates a pet in the store with form data
PetApi	UploadFile	Post /pet/{petId}/uploadImage	uploads an image
StoreApi	DeleteOrder	Delete /store/order/{order_id}	Delete purchase order by ID
StoreApi	GetInventory	Get /store/inventory	Returns pet inventories by status
StoreApi	GetOrderById	Get /store/order/{order_id}	Find purchase order by ID
StoreApi	PlaceOrder	Post /store/order	Place an order for a pet
UserApi	CreateUser	Post /user	Create user
UserApi	CreateUsersWithArrayInput	Post /user/createWithArray	Creates list of users with given input array
UserApi	CreateUsersWithListInput	Post /user/createWithList	Creates list of users with given input array
UserApi	DeleteUser	Delete /user/{username}	Delete user
UserApi	GetUserByName	Get /user/{username}	Get user by user name
UserApi	LoginUser	Get /user/login	Logs user into the system
UserApi	LogoutUser	Get /user/logout	Logs out current logged in user session
UserApi	UpdateUser	Put /user/{username}	Updated user

Documentation For Models

Documentation For Authorization

api_key

Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

api_key_query

Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

http_basic_test

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

petstore_auth

Type: OAuth
Flow: implicit
Authorization URL: http://petstore.swagger.io/api/oauth/dialog
Scopes:
****:

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Author

apiteam@swagger.io

Documentation ¶

Overview ¶

* Swagger Petstore * * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ * * API version: 1.0.0 * Contact: apiteam@swagger.io * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AdditionalPropertiesClass
type AllOfSubCategoryCategory
type AllOfSubCategoryPetsItems
type Animal
type AnimalApiDeleteAnimalOpts
type AnimalApiService
- func (a *AnimalApiService) AddAnimal(ctx context.Context, body Animal) (*http.Response, error)
- func (a *AnimalApiService) DeleteAnimal(ctx context.Context, animalId int64, ...) (*http.Response, error)
- func (a *AnimalApiService) GetAnimalById(ctx context.Context, animalId int64) (Animal, *http.Response, error)
- func (a *AnimalApiService) UpdateAnimal(ctx context.Context, body Animal) (*http.Response, error)
- func (a *AnimalApiService) UpdateAnimalWithForm(ctx context.Context, animalId int64, ...) (*http.Response, error)
type AnimalApiUpdateAnimalWithFormOpts
type AnotherFakeApiService
- func (a *AnotherFakeApiService) TestSpecialTags(ctx context.Context, body Client) (Client, *http.Response, error)
type ArrayOfArrayOfNumberOnly
type ArrayOfNumberOnly
type BasicAuth
type Body
type Body1
type Body2
type Body3
type Body4
type Body5
type Body6
type Body7
type Capitalization
type Cat
type Category
type ClassModel
type Client
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type Dog
type DogApiDeleteDogOpts
type DogApiService
- func (a *DogApiService) AddDog(ctx context.Context, body Dog) (*http.Response, error)
- func (a *DogApiService) DeleteDog(ctx context.Context, dogId int64, localVarOptionals *DogApiDeleteDogOpts) (*http.Response, error)
- func (a *DogApiService) GetDogById(ctx context.Context, dogId int64) (Dog, *http.Response, error)
- func (a *DogApiService) UpdateDog(ctx context.Context, body Dog) (*http.Response, error)
- func (a *DogApiService) UpdateDogWithForm(ctx context.Context, dogId int64, ...) (*http.Response, error)
type DogApiUpdateDogWithFormOpts
type EnumArrays
type EnumClass
type FakeApiFakeOuterBooleanSerializeOpts
type FakeApiFakeOuterCompositeSerializeOpts
type FakeApiFakeOuterNumberSerializeOpts
type FakeApiFakeOuterStringSerializeOpts
type FakeApiService
- func (a *FakeApiService) FakeOuterBooleanSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterBooleanSerializeOpts) (bool, *http.Response, error)
- func (a *FakeApiService) FakeOuterCompositeSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterCompositeSerializeOpts) (OuterComposite, *http.Response, error)
- func (a *FakeApiService) FakeOuterNumberSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterNumberSerializeOpts) (float64, *http.Response, error)
- func (a *FakeApiService) FakeOuterStringSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterStringSerializeOpts) (string, *http.Response, error)
- func (a *FakeApiService) TestClientModel(ctx context.Context, body Client) (Client, *http.Response, error)
- func (a *FakeApiService) TestEndpointParameters(ctx context.Context, body Body2) (*http.Response, error)
- func (a *FakeApiService) TestEnumParameters(ctx context.Context, localVarOptionals *FakeApiTestEnumParametersOpts) (*http.Response, error)
- func (a *FakeApiService) TestEnumRequestBody(ctx context.Context, localVarOptionals *FakeApiTestEnumRequestBodyOpts) (*http.Response, error)
- func (a *FakeApiService) TestInlineAdditionalProperties(ctx context.Context, body map[string]string) (*http.Response, error)
- func (a *FakeApiService) TestJsonFormData(ctx context.Context, body Body5) (*http.Response, error)
type FakeApiTestEnumParametersOpts
type FakeApiTestEnumRequestBodyOpts
type FakeClassnameTags123ApiService
- func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body Client) (Client, *http.Response, error)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type HasOnlyReadOnly
type List
type MixedPropertiesAndAdditionalPropertiesClass
type Model200Response
type ModelApiResponse
type ModelReturn
type Name
type NullableEnumModel
type NumberOnly
type OneOfAllPetsResponseItems
type OneOfSinglePetResponsePet
type Order
type OuterComposite
type OuterEnum
type Pet
type PetApiDeletePetOpts
type PetApiDoCategoryStuffOpts
type PetApiService
- func (a *PetApiService) AddPet(ctx context.Context, body Pet) (*http.Response, error)
- func (a *PetApiService) DeletePet(ctx context.Context, petId int64, localVarOptionals *PetApiDeletePetOpts) (*http.Response, error)
- func (a *PetApiService) DoCategoryStuff(ctx context.Context, localVarOptionals *PetApiDoCategoryStuffOpts) (ModelApiResponse, *http.Response, error)
- func (a *PetApiService) FindPetsByStatus(ctx context.Context, status []string) ([]Pet, *http.Response, error)
- func (a *PetApiService) FindPetsByTags(ctx context.Context, tags []string) ([]Pet, *http.Response, error)
- func (a *PetApiService) GetAllPets(ctx context.Context) ([]OneOfAllPetsResponseItems, *http.Response, error)
- func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http.Response, error)
- func (a *PetApiService) GetRandomPet(ctx context.Context) (SinglePetResponse, *http.Response, error)
- func (a *PetApiService) UpdatePet(ctx context.Context, body Pet) (*http.Response, error)
- func (a *PetApiService) UpdatePetWithForm(ctx context.Context, petId int64, ...) (*http.Response, error)
- func (a *PetApiService) UploadFile(ctx context.Context, petId int64, localVarOptionals *PetApiUploadFileOpts) (ModelApiResponse, *http.Response, error)
type PetApiUpdatePetWithFormOpts
type PetApiUploadFileOpts
type ReadOnlyFirst
type SinglePetResponse
type SpecialModelName
type StoreApiService
- func (a *StoreApiService) DeleteOrder(ctx context.Context, orderId string) (*http.Response, error)
- func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *http.Response, error)
- func (a *StoreApiService) GetOrderById(ctx context.Context, orderId int64) (Order, *http.Response, error)
- func (a *StoreApiService) PlaceOrder(ctx context.Context, body Order) (Order, *http.Response, error)
type SubCategory
type Tag
type User
type UserApiService
- func (a *UserApiService) CreateUser(ctx context.Context, body User) (*http.Response, error)
- func (a *UserApiService) CreateUsersWithArrayInput(ctx context.Context, body []User) (*http.Response, error)
- func (a *UserApiService) CreateUsersWithListInput(ctx context.Context, body []User) (*http.Response, error)
- func (a *UserApiService) DeleteUser(ctx context.Context, username string) (*http.Response, error)
- func (a *UserApiService) GetUserByName(ctx context.Context, username string) (User, *http.Response, error)
- func (a *UserApiService) LoginUser(ctx context.Context, username string, password string) (string, *http.Response, error)
- func (a *UserApiService) LogoutUser(ctx context.Context) (*http.Response, error)
- func (a *UserApiService) UpdateUser(ctx context.Context, body User, username string) (*http.Response, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AnimalApi *AnimalApiService

	AnotherFakeApi *AnotherFakeApiService

	DogApi *DogApiService

	FakeApi *FakeApiService

	FakeClassnameTags123Api *FakeClassnameTags123ApiService

	PetApi *PetApiService

	StoreApi *StoreApiService

	UserApi *UserApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Swagger Petstore API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AdditionalPropertiesClass ¶

type AdditionalPropertiesClass struct {
	MapProperty      map[string]string            `json:"map_property,omitempty"`
	MapOfMapProperty map[string]map[string]string `json:"map_of_map_property,omitempty"`
}

type AllOfSubCategoryCategory ¶

type AllOfSubCategoryCategory struct {
	Id    int64  `json:"id,omitempty"`
	Name  string `json:"name,omitempty"`
	Foo   bool   `json:"foo,omitempty"`
	Bar   int32  `json:"bar,omitempty"`
	Beer  string `json:"beer,omitempty"`
	Drunk *User  `json:"drunk,omitempty"`
}

type AllOfSubCategoryPetsItems ¶

type AllOfSubCategoryPetsItems struct {
	Id        int64     `json:"id,omitempty"`
	Category  *Category `json:"category,omitempty"`
	Name      string    `json:"name"`
	PhotoUrls []string  `json:"photoUrls"`
	Tags      []Tag     `json:"tags,omitempty"`
	// pet status in the store
	Status string `json:"status,omitempty"`
}

type Animal ¶

type Animal struct {
	ClassName string `json:"className"`
	Color     string `json:"color,omitempty"`
}

type AnimalApiDeleteAnimalOpts ¶

type AnimalApiDeleteAnimalOpts struct {
	ApiKey optional.String
}

type AnimalApiService ¶

type AnimalApiService service

func (*AnimalApiService) AddAnimal ¶

func (a *AnimalApiService) AddAnimal(ctx context.Context, body Animal) (*http.Response, error)

AnimalApiService Add a new animal to the store

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Animal object that needs to be added to the store

func (*AnimalApiService) DeleteAnimal ¶

func (a *AnimalApiService) DeleteAnimal(ctx context.Context, animalId int64, localVarOptionals *AnimalApiDeleteAnimalOpts) (*http.Response, error)

func (*AnimalApiService) GetAnimalById ¶

func (a *AnimalApiService) GetAnimalById(ctx context.Context, animalId int64) (Animal, *http.Response, error)

AnimalApiService Find animal by ID Returns a single animal

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param animalId ID of pet to return

@return Animal

func (*AnimalApiService) UpdateAnimal ¶

func (a *AnimalApiService) UpdateAnimal(ctx context.Context, body Animal) (*http.Response, error)

AnimalApiService Update an existing animal

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Animal object that needs to be added.

func (*AnimalApiService) UpdateAnimalWithForm ¶

func (a *AnimalApiService) UpdateAnimalWithForm(ctx context.Context, animalId int64, localVarOptionals *AnimalApiUpdateAnimalWithFormOpts) (*http.Response, error)

type AnimalApiUpdateAnimalWithFormOpts ¶

type AnimalApiUpdateAnimalWithFormOpts struct {
	Name   optional.String
	Status optional.String
}

type AnotherFakeApiService ¶

type AnotherFakeApiService service

func (*AnotherFakeApiService) TestSpecialTags ¶

func (a *AnotherFakeApiService) TestSpecialTags(ctx context.Context, body Client) (Client, *http.Response, error)

AnotherFakeApiService To test special tags To test special tags

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body client model

@return Client

type ArrayOfArrayOfNumberOnly ¶

type ArrayOfArrayOfNumberOnly struct {
	ArrayArrayNumber [][]float64 `json:"ArrayArrayNumber,omitempty"`
}

type ArrayOfNumberOnly ¶

type ArrayOfNumberOnly struct {
	ArrayNumber []float64 `json:"ArrayNumber,omitempty"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Body ¶

type Body struct {
	// Updated name of the pet
	Name string `json:"name,omitempty"`
	// Updated status of the pet
	Status string `json:"status,omitempty"`
}

type Body1 ¶

type Body1 struct {
	// Additional data to pass to server
	AdditionalMetadata string `json:"additionalMetadata,omitempty"`
	// file to upload
	File **os.File `json:"file,omitempty"`
}

type Body2 ¶

type Body2 struct {
	// None
	Integer int32 `json:"integer,omitempty"`
	// None
	Int32_ int32 `json:"int32,omitempty"`
	// None
	Int64_ int64 `json:"int64,omitempty"`
	// None
	Number float64 `json:"number"`
	// None
	Float float32 `json:"float,omitempty"`
	// None
	Double float64 `json:"double"`
	// None
	String_ string `json:"string,omitempty"`
	// None
	PatternWithoutDelimiter string `json:"pattern_without_delimiter"`
	// None
	Byte_ string `json:"byte"`
	// None
	Binary **os.File `json:"binary,omitempty"`
	// None
	Date string `json:"date,omitempty"`
	// None
	DateTime time.Time `json:"dateTime,omitempty"`
	// None
	Password string `json:"password,omitempty"`
	// None
	Callback string `json:"callback,omitempty"`
}

type Body3 ¶

type Body3 struct {
	// None
	Integer int32 `json:"integer,omitempty"`
	// None
	Int32_ int32 `json:"int32,omitempty"`
	// None
	Int64_ int64 `json:"int64,omitempty"`
	// None
	Number float64 `json:"number"`
	// None
	Float float32 `json:"float,omitempty"`
	// None
	Double float64 `json:"double"`
	// None
	String_ string `json:"string,omitempty"`
	// None
	PatternWithoutDelimiter string `json:"pattern_without_delimiter"`
	// None
	Byte_ string `json:"byte"`
	// None
	Binary **os.File `json:"binary,omitempty"`
	// None
	Date string `json:"date,omitempty"`
	// None
	DateTime time.Time `json:"dateTime,omitempty"`
	// None
	Password string `json:"password,omitempty"`
	// None
	Callback string `json:"callback,omitempty"`
}

type Body4 ¶

type Body4 struct {
	// Form parameter enum test (string array)
	EnumFormStringArray []string `json:"enum_form_string_array,omitempty"`
	// Form parameter enum test (string)
	EnumFormString string `json:"enum_form_string,omitempty"`
	// Query parameter enum test (double)
	EnumQueryDouble float64 `json:"enum_query_double,omitempty"`
}

type Body5 ¶

type Body5 struct {
	// field1
	Param string `json:"param"`
	// field2
	Param2 string `json:"param2"`
}

type Body6 ¶

type Body6 struct {
	// Updated name of the animal
	Name string `json:"name,omitempty"`
	// Updated status of the animal
	Status string `json:"status,omitempty"`
}

type Body7 ¶

type Body7 struct {
	// Updated name of the dog
	Name string `json:"name,omitempty"`
	// Updated status of the dog
	Status string `json:"status,omitempty"`
}

type Capitalization ¶

type Capitalization struct {
	SmallCamel       string `json:"smallCamel,omitempty"`
	CapitalCamel     string `json:"CapitalCamel,omitempty"`
	SmallSnake       string `json:"small_Snake,omitempty"`
	CapitalSnake     string `json:"Capital_Snake,omitempty"`
	SCAETHFlowPoints string `json:"SCA_ETH_Flow_Points,omitempty"`
	// Name of the pet
	ATT_NAME string `json:"ATT_NAME,omitempty"`
}

type Cat ¶

type Cat struct {
	ClassName string `json:"className"`
	Color     string `json:"color,omitempty"`
	Declawed  bool   `json:"declawed,omitempty"`
}

type Category ¶

type Category struct {
	Id   int64  `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type ClassModel ¶

type ClassModel struct {
	Class string `json:"_class,omitempty"`
}

Model for testing model with \"_class\" property

type Client ¶

type Client struct {
	Client string `json:"client,omitempty"`
}

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type Dog ¶

type Dog struct {
	ClassName string `json:"className"`
	Color     string `json:"color,omitempty"`
	Breed     string `json:"breed,omitempty"`
}

type DogApiDeleteDogOpts ¶

type DogApiDeleteDogOpts struct {
	ApiKey optional.String
}

type DogApiService ¶

type DogApiService service

func (*DogApiService) AddDog ¶

func (a *DogApiService) AddDog(ctx context.Context, body Dog) (*http.Response, error)

DogApiService Add a new dog to the store

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Dog object that needs to be added to the store

func (*DogApiService) DeleteDog ¶

func (a *DogApiService) DeleteDog(ctx context.Context, dogId int64, localVarOptionals *DogApiDeleteDogOpts) (*http.Response, error)

func (*DogApiService) GetDogById ¶

func (a *DogApiService) GetDogById(ctx context.Context, dogId int64) (Dog, *http.Response, error)

DogApiService Find dog by ID Returns a single dog

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dogId ID of dog to return

@return Dog

func (*DogApiService) UpdateDog ¶

func (a *DogApiService) UpdateDog(ctx context.Context, body Dog) (*http.Response, error)

DogApiService Update an existing dog

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Dog object that needs to be added.

func (*DogApiService) UpdateDogWithForm ¶

func (a *DogApiService) UpdateDogWithForm(ctx context.Context, dogId int64, localVarOptionals *DogApiUpdateDogWithFormOpts) (*http.Response, error)

type DogApiUpdateDogWithFormOpts ¶

type DogApiUpdateDogWithFormOpts struct {
	Name   optional.String
	Status optional.String
}

type EnumArrays ¶

type EnumArrays struct {
	JustSymbol string   `json:"just_symbol,omitempty"`
	ArrayEnum  []string `json:"array_enum,omitempty"`
}

type EnumClass ¶

type EnumClass string

const (
	ABC_EnumClass EnumClass = "_abc"
	EFG_EnumClass EnumClass = "-efg"
	XYZ_EnumClass EnumClass = "(xyz)"
)

List of EnumClass

type FakeApiFakeOuterBooleanSerializeOpts ¶

type FakeApiFakeOuterBooleanSerializeOpts struct {
	Body optional.Interface
}

type FakeApiFakeOuterCompositeSerializeOpts ¶

type FakeApiFakeOuterCompositeSerializeOpts struct {
	Body optional.Interface
}

type FakeApiFakeOuterNumberSerializeOpts ¶

type FakeApiFakeOuterNumberSerializeOpts struct {
	Body optional.Interface
}

type FakeApiFakeOuterStringSerializeOpts ¶

type FakeApiFakeOuterStringSerializeOpts struct {
	Body optional.Interface
}

type FakeApiService ¶

type FakeApiService service

func (*FakeApiService) FakeOuterBooleanSerialize ¶

func (a *FakeApiService) FakeOuterBooleanSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterBooleanSerializeOpts) (bool, *http.Response, error)

func (*FakeApiService) FakeOuterCompositeSerialize ¶

func (a *FakeApiService) FakeOuterCompositeSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterCompositeSerializeOpts) (OuterComposite, *http.Response, error)

func (*FakeApiService) FakeOuterNumberSerialize ¶

func (a *FakeApiService) FakeOuterNumberSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterNumberSerializeOpts) (float64, *http.Response, error)

func (*FakeApiService) FakeOuterStringSerialize ¶

func (a *FakeApiService) FakeOuterStringSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterStringSerializeOpts) (string, *http.Response, error)

func (*FakeApiService) TestClientModel ¶

func (a *FakeApiService) TestClientModel(ctx context.Context, body Client) (Client, *http.Response, error)

FakeApiService To test \"client\" model To test \"client\" model

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body client model

@return Client

func (*FakeApiService) TestEndpointParameters ¶

func (a *FakeApiService) TestEndpointParameters(ctx context.Context, body Body2) (*http.Response, error)

FakeApiService Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트 Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*FakeApiService) TestEnumParameters ¶

func (a *FakeApiService) TestEnumParameters(ctx context.Context, localVarOptionals *FakeApiTestEnumParametersOpts) (*http.Response, error)

func (*FakeApiService) TestEnumRequestBody ¶

func (a *FakeApiService) TestEnumRequestBody(ctx context.Context, localVarOptionals *FakeApiTestEnumRequestBodyOpts) (*http.Response, error)

func (*FakeApiService) TestInlineAdditionalProperties ¶

func (a *FakeApiService) TestInlineAdditionalProperties(ctx context.Context, body map[string]string) (*http.Response, error)

FakeApiService test inline additionalProperties

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body request body

func (*FakeApiService) TestJsonFormData ¶

func (a *FakeApiService) TestJsonFormData(ctx context.Context, body Body5) (*http.Response, error)

FakeApiService test json serialization of form data

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

type FakeApiTestEnumParametersOpts ¶

type FakeApiTestEnumParametersOpts struct {
	EnumHeaderStringArray optional.Interface
	EnumHeaderString      optional.String
	EnumQueryStringArray  optional.Interface
	EnumQueryString       optional.String
	EnumQueryInteger      optional.Int32
}

type FakeApiTestEnumRequestBodyOpts ¶

type FakeApiTestEnumRequestBodyOpts struct {
	Body optional.Interface
}

type FakeClassnameTags123ApiService ¶

type FakeClassnameTags123ApiService service

func (*FakeClassnameTags123ApiService) TestClassname ¶

func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body Client) (Client, *http.Response, error)

FakeClassnameTags123ApiService To test class name in snake case

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body client model

@return Client

type GenericSwaggerError ¶

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type HasOnlyReadOnly ¶

type HasOnlyReadOnly struct {
	Bar string `json:"bar,omitempty"`
	Foo string `json:"foo,omitempty"`
}

type List ¶

type List struct {
	Var123List string `json:"123-list,omitempty"`
}

type MixedPropertiesAndAdditionalPropertiesClass ¶

type MixedPropertiesAndAdditionalPropertiesClass struct {
	Uuid     string            `json:"uuid,omitempty"`
	DateTime time.Time         `json:"dateTime,omitempty"`
	Map_     map[string]Animal `json:"map,omitempty"`
}

type Model200Response ¶

type Model200Response struct {
	Name  int32  `json:"name,omitempty"`
	Class string `json:"class,omitempty"`
}

Model for testing model name starting with number

type ModelApiResponse ¶

type ModelApiResponse struct {
	Code    int32  `json:"code,omitempty"`
	Type_   string `json:"type,omitempty"`
	Message string `json:"message,omitempty"`
}

type ModelReturn ¶

type ModelReturn struct {
	Return_ int32 `json:"return,omitempty"`
}

Model for testing reserved words

type Name ¶

type Name struct {
	Name         int32  `json:"name"`
	SnakeCase    int32  `json:"snake_case,omitempty"`
	Property     string `json:"property,omitempty"`
	Var123Number int32  `json:"123Number,omitempty"`
}

Model for testing model name same as property name

type NullableEnumModel ¶

type NullableEnumModel struct {
	EnumProp string `json:"enumProp,omitempty"`
}

type NumberOnly ¶

type NumberOnly struct {
	JustNumber float64 `json:"JustNumber,omitempty"`
}

type OneOfAllPetsResponseItems ¶

type OneOfAllPetsResponseItems struct {
	Dog
	Cat
}

type OneOfSinglePetResponsePet ¶

type OneOfSinglePetResponsePet struct {
	Dog
	Cat
}

type Order ¶

type Order struct {
	Id       int64     `json:"id,omitempty"`
	PetId    int64     `json:"petId,omitempty"`
	Quantity int32     `json:"quantity,omitempty"`
	ShipDate time.Time `json:"shipDate,omitempty"`
	// Order Status
	Status   string `json:"status,omitempty"`
	Complete bool   `json:"complete,omitempty"`
}

type OuterComposite ¶

type OuterComposite struct {
	MyNumber  float64 `json:"my_number,omitempty"`
	MyString  string  `json:"my_string,omitempty"`
	MyBoolean bool    `json:"my_boolean,omitempty"`
}

type OuterEnum ¶

type OuterEnum string

const (
	PLACED_OuterEnum    OuterEnum = "placed"
	APPROVED_OuterEnum  OuterEnum = "approved"
	DELIVERED_OuterEnum OuterEnum = "delivered"
)

List of OuterEnum

type Pet ¶

type Pet struct {
	Id        int64     `json:"id,omitempty"`
	Category  *Category `json:"category,omitempty"`
	Name      string    `json:"name"`
	PhotoUrls []string  `json:"photoUrls"`
	Tags      []Tag     `json:"tags,omitempty"`
	// pet status in the store
	Status string `json:"status,omitempty"`
}

type PetApiDeletePetOpts ¶

type PetApiDeletePetOpts struct {
	ApiKey optional.String
}

type PetApiDoCategoryStuffOpts ¶

type PetApiDoCategoryStuffOpts struct {
	Body optional.Interface
}

type PetApiService ¶

type PetApiService service

func (*PetApiService) AddPet ¶

func (a *PetApiService) AddPet(ctx context.Context, body Pet) (*http.Response, error)

PetApiService Add a new pet to the store

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Pet object that needs to be added to the store

func (*PetApiService) DeletePet ¶

func (a *PetApiService) DeletePet(ctx context.Context, petId int64, localVarOptionals *PetApiDeletePetOpts) (*http.Response, error)

func (*PetApiService) DoCategoryStuff ¶

func (a *PetApiService) DoCategoryStuff(ctx context.Context, localVarOptionals *PetApiDoCategoryStuffOpts) (ModelApiResponse, *http.Response, error)

func (*PetApiService) FindPetsByStatus ¶

func (a *PetApiService) FindPetsByStatus(ctx context.Context, status []string) ([]Pet, *http.Response, error)

PetApiService Finds Pets by status Multiple status values can be provided with comma separated strings

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param status Status values that need to be considered for filter

@return []Pet

func (*PetApiService) FindPetsByTags ¶

func (a *PetApiService) FindPetsByTags(ctx context.Context, tags []string) ([]Pet, *http.Response, error)

PetApiService Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tags Tags to filter by

@return []Pet

func (*PetApiService) GetAllPets ¶

func (a *PetApiService) GetAllPets(ctx context.Context) ([]OneOfAllPetsResponseItems, *http.Response, error)

PetApiService

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []OneOfAllPetsResponseItems

func (*PetApiService) GetPetById ¶

func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http.Response, error)

PetApiService Find pet by ID Returns a single pet

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param petId ID of pet to return

@return Pet

func (*PetApiService) GetRandomPet ¶

func (a *PetApiService) GetRandomPet(ctx context.Context) (SinglePetResponse, *http.Response, error)

PetApiService

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SinglePetResponse

func (*PetApiService) UpdatePet ¶

func (a *PetApiService) UpdatePet(ctx context.Context, body Pet) (*http.Response, error)

PetApiService Update an existing pet

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Pet object that needs to be added to the store

func (*PetApiService) UpdatePetWithForm ¶

func (a *PetApiService) UpdatePetWithForm(ctx context.Context, petId int64, localVarOptionals *PetApiUpdatePetWithFormOpts) (*http.Response, error)

func (*PetApiService) UploadFile ¶

func (a *PetApiService) UploadFile(ctx context.Context, petId int64, localVarOptionals *PetApiUploadFileOpts) (ModelApiResponse, *http.Response, error)

type PetApiUpdatePetWithFormOpts ¶

type PetApiUpdatePetWithFormOpts struct {
	Name   optional.String
	Status optional.String
}

type PetApiUploadFileOpts ¶

type PetApiUploadFileOpts struct {
	AdditionalMetadata optional.String
	File               optional.Interface
}

type ReadOnlyFirst ¶

type ReadOnlyFirst struct {
	Bar string `json:"bar,omitempty"`
	Baz string `json:"baz,omitempty"`
}

type SinglePetResponse ¶

type SinglePetResponse struct {
	Pet *OneOfSinglePetResponsePet `json:"pet,omitempty"`
}

type SpecialModelName ¶

type SpecialModelName struct {
	SpecialPropertyName int64 `json:"$special[property.name],omitempty"`
}

type StoreApiService ¶

type StoreApiService service

func (*StoreApiService) DeleteOrder ¶

func (a *StoreApiService) DeleteOrder(ctx context.Context, orderId string) (*http.Response, error)

StoreApiService Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId ID of the order that needs to be deleted

func (*StoreApiService) GetInventory ¶

func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *http.Response, error)

StoreApiService Returns pet inventories by status Returns a map of status codes to quantities

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]int32

func (*StoreApiService) GetOrderById ¶

func (a *StoreApiService) GetOrderById(ctx context.Context, orderId int64) (Order, *http.Response, error)

StoreApiService Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId ID of pet that needs to be fetched

@return Order

func (*StoreApiService) PlaceOrder ¶

func (a *StoreApiService) PlaceOrder(ctx context.Context, body Order) (Order, *http.Response, error)

StoreApiService Place an order for a pet

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body order placed for purchasing the pet

@return Order

type SubCategory ¶

type SubCategory struct {
	Category  *AllOfSubCategoryCategory   `json:"category,omitempty"`
	Category2 *Category                   `json:"category2,omitempty"`
	Pets      []AllOfSubCategoryPetsItems `json:"pets,omitempty"`
}

type Tag ¶

type Tag struct {
	Id   int64  `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type User ¶

type User struct {
	Id        int64  `json:"id,omitempty"`
	Username  string `json:"username,omitempty"`
	FirstName string `json:"firstName,omitempty"`
	LastName  string `json:"lastName,omitempty"`
	Email     string `json:"email,omitempty"`
	Password  string `json:"password,omitempty"`
	Phone     string `json:"phone,omitempty"`
	// User Status
	UserStatus int32 `json:"userStatus,omitempty"`
}

type UserApiService ¶

type UserApiService service

func (*UserApiService) CreateUser ¶

func (a *UserApiService) CreateUser(ctx context.Context, body User) (*http.Response, error)

UserApiService Create user This can only be done by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Created user object

func (*UserApiService) CreateUsersWithArrayInput ¶

func (a *UserApiService) CreateUsersWithArrayInput(ctx context.Context, body []User) (*http.Response, error)

UserApiService Creates list of users with given input array

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body List of user object

func (*UserApiService) CreateUsersWithListInput ¶

func (a *UserApiService) CreateUsersWithListInput(ctx context.Context, body []User) (*http.Response, error)

UserApiService Creates list of users with given input array

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body List of user object

func (*UserApiService) DeleteUser ¶

func (a *UserApiService) DeleteUser(ctx context.Context, username string) (*http.Response, error)

UserApiService Delete user This can only be done by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param username The name that needs to be deleted

func (*UserApiService) GetUserByName ¶

func (a *UserApiService) GetUserByName(ctx context.Context, username string) (User, *http.Response, error)

UserApiService Get user by user name

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param username The name that needs to be fetched. Use user1 for testing.

@return User

func (*UserApiService) LoginUser ¶

func (a *UserApiService) LoginUser(ctx context.Context, username string, password string) (string, *http.Response, error)

UserApiService Logs user into the system

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param username The user name for login
@param password The password for login in clear text

@return string

func (*UserApiService) LogoutUser ¶

func (a *UserApiService) LogoutUser(ctx context.Context) (*http.Response, error)

UserApiService Logs out current logged in user session

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*UserApiService) UpdateUser ¶

func (a *UserApiService) UpdateUser(ctx context.Context, body User, username string) (*http.Response, error)

UserApiService Updated user This can only be done by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Updated user object
@param username name that need to be deleted

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL