Documentation
¶
Overview ¶
Package acl provides primitives to interact with the openapi HTTP API.
Code generated by github.com/do87/oapi-codegen version v0.5.0 DO NOT EDIT.
Index ¶
- Constants
- func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
- func NewUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- type AclResponse
- type Client
- func (c *Client) List(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) Update(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientWithResponses
- func (c *ClientWithResponses) ListWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*ListResponse, error)
- func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
- func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
- func (c *ClientWithResponses) UpdateWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*UpdateResponse, error)
- func (c *ClientWithResponses) UpdateWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*UpdateResponse, error)
- type ClientWithResponsesInterface
- type Error
- type ListResponse
- type Message
- type PermissionDenied
- type RequestEditorFn
- type UpdateJSONBody
- type UpdateJSONRequestBody
- type UpdateResponse
Constants ¶
const (
BearerAuthScopes = "bearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewListRequest ¶
func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
NewListRequest generates requests for List
Types ¶
type AclResponse ¶
AclResponse defines model for AclResponse.
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.
type ClientInterface ¶
type ClientInterface interface { // List request List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error) // Update request with any body UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) Update(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, 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) ListWithResponse ¶
func (c *ClientWithResponses) ListWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)
ListWithResponse request returning *ListResponse
func (*ClientWithResponses) ParseListResponse ¶
func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
ParseListResponse parses an HTTP response from a ListWithResponse call
func (*ClientWithResponses) ParseUpdateResponse ¶
func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
ParseUpdateResponse parses an HTTP response from a UpdateWithResponse call
func (*ClientWithResponses) UpdateWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
UpdateWithBodyWithResponse request with arbitrary body returning *UpdateResponse
func (*ClientWithResponses) UpdateWithResponse ¶
func (c *ClientWithResponses) UpdateWithResponse(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // List request ListWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error) // Update request with any body UpdateWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error) UpdateWithResponse(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Error ¶
type Error struct { Errors *[]map[string]string `json:"errors,omitempty"` Message string `json:"message"` }
Error defines model for Error.
type ListResponse ¶
type ListResponse struct { Body []byte HTTPResponse *http.Response JSON200 *AclResponse JSON403 *PermissionDenied HasError error // Aggregated error }
func (ListResponse) Status ¶
func (r ListResponse) Status() string
Status returns HTTPResponse.Status
func (ListResponse) StatusCode ¶
func (r ListResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Message ¶
type Message struct {
Message string `json:"message"`
}
Message defines model for Message.
type PermissionDenied ¶
type PermissionDenied struct {
Detail string `json:"detail"`
}
PermissionDenied defines model for PermissionDenied.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type UpdateJSONBody ¶
type UpdateJSONBody struct { // Acl list of cidr Acl []string `json:"acl"` }
UpdateJSONBody defines parameters for Update.
type UpdateJSONRequestBody ¶
type UpdateJSONRequestBody UpdateJSONBody
UpdateJSONRequestBody defines body for Update for application/json ContentType.
type UpdateResponse ¶
type UpdateResponse struct { Body []byte HTTPResponse *http.Response JSON202 *Message JSON400 *Error JSON403 *PermissionDenied HasError error // Aggregated error }
func (UpdateResponse) Status ¶
func (r UpdateResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateResponse) StatusCode ¶
func (r UpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode