Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AdditionalPropertiesClass
- type Animal
- type AnimalFarm
- type AnotherFakeApiService
- type ArrayOfArrayOfNumberOnly
- type ArrayOfNumberOnly
- type BasicAuth
- type Capitalization
- type Cat
- type Category
- type ClassModel
- type Client
- type Configuration
- type Dog
- type EnumArrays
- type EnumClass
- type FakeApiService
- func (a *FakeApiService) FakeOuterBooleanSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterBoolean, *http.Response, error)
- func (a *FakeApiService) FakeOuterCompositeSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterComposite, *http.Response, error)
- func (a *FakeApiService) FakeOuterNumberSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterNumber, *http.Response, error)
- func (a *FakeApiService) FakeOuterStringSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterString, *http.Response, error)
- func (a *FakeApiService) TestClientModel(ctx context.Context, body Client) (Client, *http.Response, error)
- func (a *FakeApiService) TestEndpointParameters(ctx context.Context, number float32, double float64, ...) (*http.Response, error)
- func (a *FakeApiService) TestEnumParameters(ctx context.Context, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *FakeApiService) TestInlineAdditionalProperties(ctx context.Context, param interface{}) (*http.Response, error)
- func (a *FakeApiService) TestJsonFormData(ctx context.Context, param string, param2 string) (*http.Response, error)
- type FakeClassnameTags123ApiService
- type HasOnlyReadOnly
- type List
- type MixedPropertiesAndAdditionalPropertiesClass
- type Model200Response
- type ModelApiResponse
- type ModelReturn
- type Name
- type NumberOnly
- type Order
- type OuterBoolean
- type OuterComposite
- type OuterEnum
- type OuterNumber
- type OuterString
- type Pet
- type PetApiService
- func (a *PetApiService) AddPet(ctx context.Context, body Pet) (*http.Response, error)
- func (a *PetApiService) DeletePet(ctx context.Context, petId int64, localVarOptionals map[string]interface{}) (*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) GetPetById(ctx context.Context, petId int64) (Pet, *http.Response, error)
- func (a *PetApiService) UpdatePet(ctx context.Context, body Pet) (*http.Response, error)
- func (a *PetApiService) UpdatePetWithForm(ctx context.Context, petId int64, localVarOptionals map[string]interface{}) (*http.Response, error)
- func (a *PetApiService) UploadFile(ctx context.Context, petId int64, localVarOptionals map[string]interface{}) (ModelApiResponse, *http.Response, error)
- type ReadOnlyFirst
- 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 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, username string, body User) (*http.Response, error)
Constants ¶
This section is empty.
Variables ¶
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 ¶
Types ¶
type APIClient ¶
type APIClient struct { // API Services AnotherFakeApi *AnotherFakeApiService 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 ¶
Change base path to allow switching to mocks
type APIKey ¶
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 AnimalFarm ¶
type AnimalFarm struct { }
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, tracing, etc. @param body client model @return Client
type ArrayOfArrayOfNumberOnly ¶
type ArrayOfArrayOfNumberOnly struct {
ArrayArrayNumber [][]float32 `json:"ArrayArrayNumber,omitempty"`
}
type ArrayOfNumberOnly ¶
type ArrayOfNumberOnly struct {
ArrayNumber []float32 `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 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 ClassModel ¶
type ClassModel struct {
Class string `json:"_class,omitempty"`
}
Model for testing model with \"_class\" property
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 EnumArrays ¶
type FakeApiService ¶
type FakeApiService service
func (*FakeApiService) FakeOuterBooleanSerialize ¶
func (a *FakeApiService) FakeOuterBooleanSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterBoolean, *http.Response, error)
FakeApiService Test serialization of outer boolean types * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:
@param "body" (OuterBoolean) Input boolean as post body
@return OuterBoolean
func (*FakeApiService) FakeOuterCompositeSerialize ¶
func (a *FakeApiService) FakeOuterCompositeSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterComposite, *http.Response, error)
FakeApiService Test serialization of object with outer number type * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:
@param "body" (OuterComposite) Input composite as post body
@return OuterComposite
func (*FakeApiService) FakeOuterNumberSerialize ¶
func (a *FakeApiService) FakeOuterNumberSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterNumber, *http.Response, error)
FakeApiService Test serialization of outer number types * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:
@param "body" (OuterNumber) Input number as post body
@return OuterNumber
func (*FakeApiService) FakeOuterStringSerialize ¶
func (a *FakeApiService) FakeOuterStringSerialize(ctx context.Context, localVarOptionals map[string]interface{}) (OuterString, *http.Response, error)
FakeApiService Test serialization of outer string types * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:
@param "body" (OuterString) Input string as post body
@return OuterString
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, tracing, etc. @param body client model @return Client
func (*FakeApiService) TestEndpointParameters ¶
func (a *FakeApiService) TestEndpointParameters(ctx context.Context, number float32, double float64, patternWithoutDelimiter string, byte_ string, localVarOptionals map[string]interface{}) (*http.Response, error)
FakeApiService Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 * @param ctx context.Context for authentication, logging, tracing, etc. @param number None @param double None @param patternWithoutDelimiter None @param byte_ None @param optional (nil or map[string]interface{}) with one or more of:
@param "integer" (int32) None @param "int32_" (int32) None @param "int64_" (int64) None @param "float" (float32) None @param "string_" (string) None @param "binary" (string) None @param "date" (string) None @param "dateTime" (time.Time) None @param "password" (string) None @param "callback" (string) None
@return
func (*FakeApiService) TestEnumParameters ¶
func (a *FakeApiService) TestEnumParameters(ctx context.Context, localVarOptionals map[string]interface{}) (*http.Response, error)
FakeApiService To test enum parameters To test enum parameters * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:
@param "enumFormStringArray" ([]string) Form parameter enum test (string array) @param "enumFormString" (string) Form parameter enum test (string) @param "enumHeaderStringArray" ([]string) Header parameter enum test (string array) @param "enumHeaderString" (string) Header parameter enum test (string) @param "enumQueryStringArray" ([]string) Query parameter enum test (string array) @param "enumQueryString" (string) Query parameter enum test (string) @param "enumQueryInteger" (int32) Query parameter enum test (double) @param "enumQueryDouble" (float64) Query parameter enum test (double)
@return
func (*FakeApiService) TestInlineAdditionalProperties ¶
func (a *FakeApiService) TestInlineAdditionalProperties(ctx context.Context, param interface{}) (*http.Response, error)
FakeApiService test inline additionalProperties
* @param ctx context.Context for authentication, logging, tracing, etc. @param param request body @return
func (*FakeApiService) TestJsonFormData ¶
func (a *FakeApiService) TestJsonFormData(ctx context.Context, param string, param2 string) (*http.Response, error)
FakeApiService test json serialization of form data
* @param ctx context.Context for authentication, logging, tracing, etc. @param param field1 @param param2 field2 @return
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, tracing, etc. @param body client model @return Client
type HasOnlyReadOnly ¶
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 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 NumberOnly ¶
type NumberOnly struct {
JustNumber float32 `json:"JustNumber,omitempty"`
}
type OuterBoolean ¶
type OuterBoolean struct { }
type OuterComposite ¶
type OuterComposite struct { MyNumber *OuterNumber `json:"my_number,omitempty"` MyString *OuterString `json:"my_string,omitempty"` MyBoolean *OuterBoolean `json:"my_boolean,omitempty"` }
type OuterNumber ¶
type OuterNumber struct { }
type OuterString ¶
type OuterString struct { }
type PetApiService ¶
type PetApiService service
func (*PetApiService) AddPet ¶
PetApiService Add a new pet to the store
* @param ctx context.Context for authentication, logging, tracing, etc. @param body Pet object that needs to be added to the store @return
func (*PetApiService) DeletePet ¶
func (a *PetApiService) DeletePet(ctx context.Context, petId int64, localVarOptionals map[string]interface{}) (*http.Response, error)
PetApiService Deletes a pet
* @param ctx context.Context for authentication, logging, tracing, etc. @param petId Pet id to delete @param optional (nil or map[string]interface{}) with one or more of:
@param "apiKey" (string)
@return
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, tracing, etc. @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, tracing, etc. @param tags Tags to filter by @return []Pet
func (*PetApiService) GetPetById ¶
PetApiService Find pet by ID Returns a single pet * @param ctx context.Context for authentication, logging, tracing, etc. @param petId ID of pet to return @return Pet
func (*PetApiService) UpdatePet ¶
PetApiService Update an existing pet
* @param ctx context.Context for authentication, logging, tracing, etc. @param body Pet object that needs to be added to the store @return
func (*PetApiService) UpdatePetWithForm ¶
func (a *PetApiService) UpdatePetWithForm(ctx context.Context, petId int64, localVarOptionals map[string]interface{}) (*http.Response, error)
PetApiService Updates a pet in the store with form data
* @param ctx context.Context for authentication, logging, tracing, etc. @param petId ID of pet that needs to be updated @param optional (nil or map[string]interface{}) with one or more of:
@param "name" (string) Updated name of the pet @param "status" (string) Updated status of the pet
@return
func (*PetApiService) UploadFile ¶
func (a *PetApiService) UploadFile(ctx context.Context, petId int64, localVarOptionals map[string]interface{}) (ModelApiResponse, *http.Response, error)
PetApiService uploads an image
* @param ctx context.Context for authentication, logging, tracing, etc. @param petId ID of pet to update @param optional (nil or map[string]interface{}) with one or more of:
@param "additionalMetadata" (string) Additional data to pass to server @param "file" (*os.File) file to upload
@return ModelApiResponse
type ReadOnlyFirst ¶
type SpecialModelName ¶
type SpecialModelName struct {
SpecialPropertyName int64 `json:"$special[property.name],omitempty"`
}
type StoreApiService ¶
type StoreApiService service
func (*StoreApiService) DeleteOrder ¶
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, tracing, etc. @param orderId ID of the order that needs to be deleted @return
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, tracing, etc. @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, tracing, etc. @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, tracing, etc. @param body order placed for purchasing the pet @return Order
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 ¶
UserApiService Create user This can only be done by the logged in user. * @param ctx context.Context for authentication, logging, tracing, etc. @param body Created user object @return
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, tracing, etc. @param body List of user object @return
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, tracing, etc. @param body List of user object @return
func (*UserApiService) DeleteUser ¶
UserApiService Delete user This can only be done by the logged in user. * @param ctx context.Context for authentication, logging, tracing, etc. @param username The name that needs to be deleted @return
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, tracing, etc. @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, tracing, etc. @param username The user name for login @param password The password for login in clear text @return string
func (*UserApiService) LogoutUser ¶
UserApiService Logs out current logged in user session
* @param ctx context.Context for authentication, logging, tracing, etc. @return
func (*UserApiService) UpdateUser ¶
func (a *UserApiService) UpdateUser(ctx context.Context, username string, body User) (*http.Response, error)
UserApiService Updated user This can only be done by the logged in user. * @param ctx context.Context for authentication, logging, tracing, etc. @param username name that need to be deleted @param body Updated user object @return
Source Files ¶
- additional_properties_class.go
- animal.go
- animal_farm.go
- another_fake_api.go
- api_client.go
- api_response.go
- array_of_array_of_number_only.go
- array_of_number_only.go
- capitalization.go
- cat.go
- category.go
- class_model.go
- client.go
- configuration.go
- dog.go
- enum_arrays.go
- enum_class.go
- fake_api.go
- fake_classname_tags123_api.go
- has_only_read_only.go
- list.go
- mixed_properties_and_additional_properties_class.go
- model_200_response.go
- model_api_response.go
- model_return.go
- name.go
- number_only.go
- order.go
- outer_boolean.go
- outer_composite.go
- outer_enum.go
- outer_number.go
- outer_string.go
- pet.go
- pet_api.go
- read_only_first.go
- special_model_name.go
- store_api.go
- tag.go
- user.go
- user_api.go