operations

Documentation

Index

• type APIError
  • func NewAPIError(opName string, response interface{}, code int) APIError
  • func (a APIError) Error() string
• type Client
  • func New(transport client.Transport, formats strfmt.Registry) *Client
  • func (a *Client) GetSearch(params GetSearchParams) (*GetSearchOK, error)
  • func (a *Client) SetTransport(transport client.Transport)
• type GetSearchBadRequest
• type GetSearchNotFound
• type GetSearchOK
• type GetSearchParams
  • func (o *GetSearchParams) WriteToRequest(r client.Request, reg strfmt.Registry) error
• type GetSearchReader
  • func (o *GetSearchReader) ReadResponse(response client.Response, consumer httpkit.Consumer) (interface{}, error)

Types

type APIError

type APIError struct {
	OperationName string
	Response      interface{}
	Code          int
}

APIError wraps an error model and captures the status code

func NewAPIError

func NewAPIError(opName string, response interface{}, code int) APIError

NewAPIError creates a new API error

func (APIError) Error

func (a APIError) Error() string

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for operations API

func New

func New(transport client.Transport, formats strfmt.Registry) *Client

New creates a new operations API client.

func (*Client) GetSearch

func (a *Client) GetSearch(params GetSearchParams) (*GetSearchOK, error)

Returns Jira Issues that match the query

func (*Client) SetTransport

func (a *Client) SetTransport(transport client.Transport)

SetTransport changes the transport on the client

type GetSearchBadRequest

type GetSearchBadRequest struct {
	Payload *models.BadRequest
}

GetSearchBadRequest

Bad Request

type GetSearchNotFound

type GetSearchNotFound struct {
	Payload models.NotFound
}

GetSearchNotFound

Not Found

type GetSearchOK

type GetSearchOK struct {
	Payload *models.SearchResponse
}

GetSearchOK

Success

type GetSearchParams

type GetSearchParams struct {

	/*Expand
	  A comma-separated list of the parameters to expand

	*/
	Expand string
	/*Fields
	  The list of fields to return for each issue. By default, all navigable fields are returned

	*/
	Fields string
	/*Jql*/
	Jql string
	/*MaxResults
	  The maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated.

	*/
	MaxResults int64
	/*StartAt
	  the index of the first issue to return (0-based)

	*/
	StartAt int64
}

GetSearchParams contains all the parameters to send to the API endpoint for the get search operation typically these are written to a http.Request

func (*GetSearchParams) WriteToRequest

func (o *GetSearchParams) WriteToRequest(r client.Request, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetSearchReader

type GetSearchReader struct {
	// contains filtered or unexported fields
}

func (*GetSearchReader) ReadResponse

func (o *GetSearchReader) ReadResponse(response client.Response, consumer httpkit.Consumer) (interface{}, error)