Documentation ¶
Overview ¶
Package accesskey provides primitives to interact with the openapi HTTP API.
Code generated by github.com/do87/oapi-codegen version v0.5.1 DO NOT EDIT.
Index ¶
- func NewCreateRequest(ctx context.Context, server string, projectID string, params *CreateParams, ...) (*http.Request, error)
- func NewCreateRequestWithBody(ctx context.Context, server string, projectID string, params *CreateParams, ...) (*http.Request, error)
- func NewDeleteRequest(ctx context.Context, server string, projectID string, keyID string, ...) (*http.Request, error)
- func NewGetRequest(ctx context.Context, server string, projectID string, params *GetParams) (*http.Request, error)
- type Client
- func (c *Client) Create(ctx context.Context, projectID string, params *CreateParams, ...) (*http.Response, error)
- func (c *Client) CreateWithBody(ctx context.Context, projectID string, params *CreateParams, ...) (*http.Response, error)
- func (c *Client) Delete(ctx context.Context, projectID string, keyID string, params *DeleteParams, ...) (*http.Response, error)
- func (c *Client) Get(ctx context.Context, projectID string, params *GetParams, ...) (*http.Response, error)
- type ClientInterface
- type ClientWithResponses
- func (c *ClientWithResponses) CreateWithBodyWithResponse(ctx context.Context, projectID string, params *CreateParams, ...) (*CreateResponse, error)
- func (c *ClientWithResponses) CreateWithResponse(ctx context.Context, projectID string, params *CreateParams, ...) (*CreateResponse, error)
- func (c *ClientWithResponses) DeleteWithResponse(ctx context.Context, projectID string, keyID string, params *DeleteParams, ...) (*DeleteResponse, error)
- func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, params *GetParams, ...) (*GetResponse, error)
- func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
- func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
- func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
- type ClientWithResponsesInterface
- type CreateJSONBody
- type CreateJSONRequestBody
- type CreateParams
- type CreateResponse
- type DeleteParams
- type DeleteResponse
- type GetParams
- type GetResponse
- type RequestEditorFn
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCreateRequest ¶
func NewCreateRequest(ctx context.Context, server string, projectID string, params *CreateParams, body CreateJSONRequestBody) (*http.Request, error)
NewCreateRequest calls the generic Create builder with application/json body
func NewCreateRequestWithBody ¶
func NewCreateRequestWithBody(ctx context.Context, server string, projectID string, params *CreateParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateRequestWithBody generates requests for Create 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) Create ¶
func (c *Client) Create(ctx context.Context, projectID string, params *CreateParams, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateWithBody ¶
type ClientInterface ¶
type ClientInterface interface { // Create request with any body CreateWithBody(ctx context.Context, projectID string, params *CreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) Create(ctx context.Context, projectID string, params *CreateParams, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) // Delete request Delete(ctx context.Context, projectID string, keyID string, params *DeleteParams, reqEditors ...RequestEditorFn) (*http.Response, error) // Get request Get(ctx context.Context, projectID string, params *GetParams, 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) CreateWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateWithBodyWithResponse(ctx context.Context, projectID string, params *CreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error)
CreateWithBodyWithResponse request with arbitrary body returning *CreateResponse
func (*ClientWithResponses) CreateWithResponse ¶
func (c *ClientWithResponses) CreateWithResponse(ctx context.Context, projectID string, params *CreateParams, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error)
func (*ClientWithResponses) DeleteWithResponse ¶
func (c *ClientWithResponses) DeleteWithResponse(ctx context.Context, projectID string, keyID string, params *DeleteParams, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
DeleteWithResponse request returning *DeleteResponse
func (*ClientWithResponses) GetWithResponse ¶
func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, params *GetParams, reqEditors ...RequestEditorFn) (*GetResponse, error)
GetWithResponse request returning *GetResponse
func (*ClientWithResponses) ParseCreateResponse ¶
func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
ParseCreateResponse parses an HTTP response from a CreateWithResponse call
func (*ClientWithResponses) ParseDeleteResponse ¶
func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
ParseDeleteResponse parses an HTTP response from a DeleteWithResponse call
func (*ClientWithResponses) ParseGetResponse ¶
func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
ParseGetResponse parses an HTTP response from a GetWithResponse call
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // Create request with any body CreateWithBodyWithResponse(ctx context.Context, projectID string, params *CreateParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error) CreateWithResponse(ctx context.Context, projectID string, params *CreateParams, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error) // Delete request DeleteWithResponse(ctx context.Context, projectID string, keyID string, params *DeleteParams, reqEditors ...RequestEditorFn) (*DeleteResponse, error) // Get request GetWithResponse(ctx context.Context, projectID string, params *GetParams, reqEditors ...RequestEditorFn) (*GetResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CreateJSONBody ¶
type CreateJSONBody struct { // Expires Expiration date. Null means never expires. Expires *time.Time `json:"expires,omitempty"` }
CreateJSONBody defines parameters for Create.
type CreateJSONRequestBody ¶
type CreateJSONRequestBody CreateJSONBody
CreateJSONRequestBody defines body for Create for application/json ContentType.
type CreateParams ¶
type CreateParams struct {
CredentialsGroup *string `form:"credentials-group,omitempty" json:"credentials-group,omitempty"`
}
CreateParams defines parameters for Create.
type CreateResponse ¶
type CreateResponse struct { Body []byte HTTPResponse *http.Response JSON201 *struct { // AccessKey Access key AccessKey string `json:"accessKey"` // DisplayName Obfuscated access key DisplayName string `json:"displayName"` // Expires Expiration date. Null means never expires. Expires string `json:"expires"` // KeyId Identifies the pair of access key and secret access key for deletion KeyID string `json:"keyId"` // Project Project ID Project string `json:"project"` // SecretAccessKey Secret access key SecretAccessKey string `json:"secretAccessKey"` } JSON403 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } JSON404 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } JSON422 *struct { Details *[]struct { Loc []string `json:"loc"` Msg string `json:"msg"` Type string `json:"type"` } `json:"detail,omitempty"` } JSON500 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } HasError error // Aggregated error }
func (CreateResponse) Status ¶
func (r CreateResponse) Status() string
Status returns HTTPResponse.Status
func (CreateResponse) StatusCode ¶
func (r CreateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteParams ¶
type DeleteParams struct {
CredentialsGroup *string `form:"credentials-group,omitempty" json:"credentials-group,omitempty"`
}
DeleteParams defines parameters for Delete.
type DeleteResponse ¶
type DeleteResponse struct { Body []byte HTTPResponse *http.Response JSON200 *struct { // KeyId Identifies the pair of access key and secret access key for deletion KeyID string `json:"keyId"` // Project Project ID Project string `json:"project"` } JSON307 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } JSON403 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } JSON404 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } JSON422 *struct { Details *[]struct { Loc []string `json:"loc"` Msg string `json:"msg"` Type string `json:"type"` } `json:"detail,omitempty"` } JSON500 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } HasError error // Aggregated error }
func (DeleteResponse) Status ¶
func (r DeleteResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteResponse) StatusCode ¶
func (r DeleteResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetParams ¶
type GetParams struct {
CredentialsGroup *string `form:"credentials-group,omitempty" json:"credentials-group,omitempty"`
}
GetParams defines parameters for Get.
type GetResponse ¶
type GetResponse struct { Body []byte HTTPResponse *http.Response JSON200 *struct { AccessKeys []struct { DisplayName string `json:"displayName"` Expires string `json:"expires"` // KeyId Identifies the pair of access key and secret access key for deletion KeyID string `json:"keyId"` } `json:"accessKeys"` // Project Project ID Project string `json:"project"` } JSON403 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } JSON404 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } JSON422 *struct { Details *[]struct { Loc []string `json:"loc"` Msg string `json:"msg"` Type string `json:"type"` } `json:"detail,omitempty"` } JSON500 *struct { Details []struct { Key string `json:"key"` Msg string `json:"msg"` } `json:"detail"` } HasError error // Aggregated error }
func (GetResponse) StatusCode ¶
func (r GetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode