petstore

package
v2.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 22, 2017 License: Apache-2.0 Imports: 20 Imported by: 0

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.languages.GoClientCodegen

Installation

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

    "./petstore"

Documentation for API Endpoints

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

Class Method HTTP request Description
AnotherFakeApi TestSpecialTags Patch /another-fake/dummy To test special tags
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 TestInlineAdditionalProperties Post /fake/inline-additionalProperties test inline additionalProperties
FakeApi TestJsonFormData Get /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 FindPetsByStatus Get /pet/findByStatus Finds Pets by status
PetApi FindPetsByTags Get /pet/findByTags Finds Pets by tags
PetApi GetPetById Get /pet/{petId} Find pet by ID
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

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

Index

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 {

	// 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 

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 Animal 

type Animal struct {
	ClassName string `json:"className"`

	Color string `json:"color,omitempty"`
}

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 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 EnumArrays 

type EnumArrays struct {
	JustSymbol string `json:"just_symbol,omitempty"`

	ArrayEnum []string `json:"array_enum,omitempty"`
}

type EnumClass 

type EnumClass string
const (
	ABC EnumClass = "_abc"
	EFG EnumClass = "-efg"
	XYZ EnumClass = "(xyz)"
)

List of EnumClass

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 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 NumberOnly 

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

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 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 OuterEnum 

type OuterEnum string
const (
	PLACED    OuterEnum = "placed"
	APPROVED  OuterEnum = "approved"
	DELIVERED OuterEnum = "delivered"
)

List of OuterEnum

type OuterNumber 

type OuterNumber struct {
}

type OuterString 

type OuterString struct {
}

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 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, 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 

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, tracing, etc. @param petId ID of pet to return @return Pet

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, 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 ReadOnlyFirst struct {
	Bar string `json:"bar,omitempty"`

	Baz string `json:"baz,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, 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 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, 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 

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, 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 

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, 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

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.