Documentation
¶
Overview ¶
Package users provides primitives to interact with the openapi HTTP API.
Code generated by github.com/do87/oapi-codegen version v0.4.0 DO NOT EDIT.
Index ¶
- Constants
- func NewGetInstanceUserRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewGetInstanceUsersRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
- func NewPostInstanceUsersRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewPostInstanceUsersRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- type Client
- func (c *Client) GetInstanceUser(ctx context.Context, projectID string, instanceID string, userID string, ...) (*http.Response, error)
- func (c *Client) GetInstanceUsers(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) PostInstanceUsers(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) PostInstanceUsersWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientWithResponses
- func (c *ClientWithResponses) GetInstanceUserWithResponse(ctx context.Context, projectID string, instanceID string, userID string, ...) (*GetInstanceUserResponse, error)
- func (c *ClientWithResponses) GetInstanceUsersWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*GetInstanceUsersResponse, error)
- func (c *ClientWithResponses) ParseGetInstanceUserResponse(rsp *http.Response) (*GetInstanceUserResponse, error)
- func (c *ClientWithResponses) ParseGetInstanceUsersResponse(rsp *http.Response) (*GetInstanceUsersResponse, error)
- func (c *ClientWithResponses) ParsePostInstanceUsersResponse(rsp *http.Response) (*PostInstanceUsersResponse, error)
- func (c *ClientWithResponses) PostInstanceUsersWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*PostInstanceUsersResponse, error)
- func (c *ClientWithResponses) PostInstanceUsersWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*PostInstanceUsersResponse, error)
- type ClientWithResponsesInterface
- type GetInstanceUserResponse
- type GetInstanceUsersResponse
- type InstanceCreateUserRequest
- type InstanceCreateUserResponse
- type InstanceError
- type InstanceGetUserResponse
- type InstanceListUser
- type InstanceListUserResponse
- type InstanceResponseUser
- type InstanceUser
- type PostInstanceUsersJSONRequestBody
- type PostInstanceUsersResponse
- type RequestEditorFn
Constants ¶
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewGetInstanceUserRequest ¶
func NewGetInstanceUserRequest(ctx context.Context, server string, projectID string, instanceID string, userID string) (*http.Request, error)
NewGetInstanceUserRequest generates requests for GetInstanceUser
func NewGetInstanceUsersRequest ¶
func NewGetInstanceUsersRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
NewGetInstanceUsersRequest generates requests for GetInstanceUsers
func NewPostInstanceUsersRequest ¶
func NewPostInstanceUsersRequest(ctx context.Context, server string, projectID string, instanceID string, body PostInstanceUsersJSONRequestBody) (*http.Request, error)
NewPostInstanceUsersRequest calls the generic PostInstanceUsers builder with application/json body
func NewPostInstanceUsersRequestWithBody ¶
func NewPostInstanceUsersRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)
NewPostInstanceUsersRequestWithBody generates requests for PostInstanceUsers with any type of body
Types ¶
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client common.Client
}
Client which conforms to the OpenAPI3 specification for this service.
func (*Client) GetInstanceUser ¶
func (*Client) GetInstanceUsers ¶
func (*Client) PostInstanceUsers ¶
func (c *Client) PostInstanceUsers(ctx context.Context, projectID string, instanceID string, body PostInstanceUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface {
// GetInstanceUsers request
GetInstanceUsers(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostInstanceUsers request with any body
PostInstanceUsersWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostInstanceUsers(ctx context.Context, projectID string, instanceID string, body PostInstanceUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetInstanceUser request
GetInstanceUser(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, httpClient common.Client) *ClientWithResponses
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetInstanceUserWithResponse ¶
func (c *ClientWithResponses) GetInstanceUserWithResponse(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*GetInstanceUserResponse, error)
GetInstanceUserWithResponse request returning *GetInstanceUserResponse
func (*ClientWithResponses) GetInstanceUsersWithResponse ¶
func (c *ClientWithResponses) GetInstanceUsersWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetInstanceUsersResponse, error)
GetInstanceUsersWithResponse request returning *GetInstanceUsersResponse
func (*ClientWithResponses) ParseGetInstanceUserResponse ¶
func (c *ClientWithResponses) ParseGetInstanceUserResponse(rsp *http.Response) (*GetInstanceUserResponse, error)
ParseGetInstanceUserResponse parses an HTTP response from a GetInstanceUserWithResponse call
func (*ClientWithResponses) ParseGetInstanceUsersResponse ¶
func (c *ClientWithResponses) ParseGetInstanceUsersResponse(rsp *http.Response) (*GetInstanceUsersResponse, error)
ParseGetInstanceUsersResponse parses an HTTP response from a GetInstanceUsersWithResponse call
func (*ClientWithResponses) ParsePostInstanceUsersResponse ¶
func (c *ClientWithResponses) ParsePostInstanceUsersResponse(rsp *http.Response) (*PostInstanceUsersResponse, error)
ParsePostInstanceUsersResponse parses an HTTP response from a PostInstanceUsersWithResponse call
func (*ClientWithResponses) PostInstanceUsersWithBodyWithResponse ¶
func (c *ClientWithResponses) PostInstanceUsersWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostInstanceUsersResponse, error)
PostInstanceUsersWithBodyWithResponse request with arbitrary body returning *PostInstanceUsersResponse
func (*ClientWithResponses) PostInstanceUsersWithResponse ¶
func (c *ClientWithResponses) PostInstanceUsersWithResponse(ctx context.Context, projectID string, instanceID string, body PostInstanceUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstanceUsersResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// GetInstanceUsers request
GetInstanceUsersWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetInstanceUsersResponse, error)
// PostInstanceUsers request with any body
PostInstanceUsersWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostInstanceUsersResponse, error)
PostInstanceUsersWithResponse(ctx context.Context, projectID string, instanceID string, body PostInstanceUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstanceUsersResponse, error)
// GetInstanceUser request
GetInstanceUserWithResponse(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*GetInstanceUserResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type GetInstanceUserResponse ¶
type GetInstanceUserResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *InstanceGetUserResponse
JSON400 *InstanceError
HasError error // Aggregated error
}
func (GetInstanceUserResponse) Status ¶
func (r GetInstanceUserResponse) Status() string
Status returns HTTPResponse.Status
func (GetInstanceUserResponse) StatusCode ¶
func (r GetInstanceUserResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetInstanceUsersResponse ¶
type GetInstanceUsersResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *InstanceListUserResponse
JSON400 *InstanceError
HasError error // Aggregated error
}
func (GetInstanceUsersResponse) Status ¶
func (r GetInstanceUsersResponse) Status() string
Status returns HTTPResponse.Status
func (GetInstanceUsersResponse) StatusCode ¶
func (r GetInstanceUsersResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type InstanceCreateUserRequest ¶
type InstanceCreateUserRequest struct {
Database *string `json:"database,omitempty"`
Roles *[]string `json:"roles,omitempty"`
Username *string `json:"username,omitempty"`
}
InstanceCreateUserRequest defines model for instance.CreateUserRequest.
type InstanceCreateUserResponse ¶
type InstanceCreateUserResponse struct {
Item *InstanceUser `json:"item,omitempty"`
}
InstanceCreateUserResponse defines model for instance.CreateUserResponse.
type InstanceError ¶
type InstanceError struct {
Code *int `json:"code,omitempty"`
Fields *map[string][]string `json:"fields,omitempty"`
Message *string `json:"message,omitempty"`
Type *string `json:"type,omitempty"`
}
InstanceError defines model for instance.Error.
type InstanceGetUserResponse ¶
type InstanceGetUserResponse struct {
Item *InstanceResponseUser `json:"item,omitempty"`
}
InstanceGetUserResponse defines model for instance.GetUserResponse.
type InstanceListUser ¶
type InstanceListUser struct {
ID *string `json:"id,omitempty"`
Username *string `json:"username,omitempty"`
}
InstanceListUser defines model for instance.ListUser.
type InstanceListUserResponse ¶
type InstanceListUserResponse struct {
Count *int `json:"count,omitempty"`
Items *[]InstanceListUser `json:"items,omitempty"`
}
InstanceListUserResponse defines model for instance.ListUserResponse.
type InstanceResponseUser ¶
type InstanceResponseUser struct {
Database *string `json:"database,omitempty"`
Host *string `json:"host,omitempty"`
ID *string `json:"id,omitempty"`
Port *int `json:"port,omitempty"`
Roles *[]string `json:"roles,omitempty"`
Username *string `json:"username,omitempty"`
}
InstanceResponseUser defines model for instance.ResponseUser.
type InstanceUser ¶
type InstanceUser struct {
Database *string `json:"database,omitempty"`
Host *string `json:"host,omitempty"`
ID *string `json:"id,omitempty"`
Password *string `json:"password,omitempty"`
Port *int `json:"port,omitempty"`
Roles *[]string `json:"roles,omitempty"`
Uri *string `json:"uri,omitempty"`
Username *string `json:"username,omitempty"`
}
InstanceUser defines model for instance.User.
type PostInstanceUsersJSONRequestBody ¶
type PostInstanceUsersJSONRequestBody = InstanceCreateUserRequest
PostInstanceUsersJSONRequestBody defines body for PostInstanceUsers for application/json ContentType.
type PostInstanceUsersResponse ¶
type PostInstanceUsersResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *InstanceCreateUserResponse
JSON400 *InstanceError
HasError error // Aggregated error
}
func (PostInstanceUsersResponse) Status ¶
func (r PostInstanceUsersResponse) Status() string
Status returns HTTPResponse.Status
func (PostInstanceUsersResponse) StatusCode ¶
func (r PostInstanceUsersResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode