client

package
v0.44.0 Latest Latest
Warning

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

Go to latest
Published: Mar 18, 2025 License: Apache-2.0 Imports: 12 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildCreatePayload

func BuildCreatePayload(aspectCreateBody string, aspectCreateEntity string, aspectCreateSchema string, aspectCreatePolicy string, aspectCreateJWT string, aspectCreateContentType string) (*aspect.CreatePayload, error)

BuildCreatePayload builds the payload for the aspect create endpoint from CLI flags.

func BuildListPayload

func BuildListPayload(aspectListEntity string, aspectListSchema string, aspectListContentPath string, aspectListAtTime string, aspectListLimit string, aspectListFilter string, aspectListOrderBy string, aspectListOrderDirection string, aspectListIncludeContent string, aspectListPage string, aspectListJWT string) (*aspect.ListPayload, error)

BuildListPayload builds the payload for the aspect list endpoint from CLI flags.

func BuildReadPayload

func BuildReadPayload(aspectReadID string, aspectReadJWT string) (*aspect.ReadPayload, error)

BuildReadPayload builds the payload for the aspect read endpoint from CLI flags.

func BuildRetractPayload

func BuildRetractPayload(aspectRetractID string, aspectRetractJWT string) (*aspect.RetractPayload, error)

BuildRetractPayload builds the payload for the aspect retract endpoint from CLI flags.

func BuildUpdatePayload

func BuildUpdatePayload(aspectUpdateBody string, aspectUpdateEntity string, aspectUpdateSchema string, aspectUpdatePolicy string, aspectUpdateJWT string, aspectUpdateContentType string) (*aspect.UpdatePayload, error)

BuildUpdatePayload builds the payload for the aspect update endpoint from CLI flags.

func CreateAspectPath

func CreateAspectPath() string

CreateAspectPath returns the URL path to the aspect service create HTTP endpoint.

func DecodeCreateResponse

func DecodeCreateResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeCreateResponse returns a decoder for responses returned by the aspect create endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeCreateResponse may return the following errors:

  • "bad-request" (type *aspect.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *aspect.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *aspect.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *aspect.NotImplementedT): http.StatusNotImplemented
  • "not-available" (type *aspect.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *aspect.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeListResponse

func DecodeListResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListResponse returns a decoder for responses returned by the aspect list endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListResponse may return the following errors:

  • "bad-request" (type *aspect.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *aspect.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *aspect.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *aspect.NotImplementedT): http.StatusNotImplemented
  • "not-available" (type *aspect.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *aspect.UnauthorizedT): http.StatusUnauthorized
  • "unsupported-content-type" (type *aspect.UnsupportedContentTypeT): http.StatusUnsupportedMediaType
  • error: internal error

func DecodeReadResponse

func DecodeReadResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeReadResponse returns a decoder for responses returned by the aspect read endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeReadResponse may return the following errors:

  • "bad-request" (type *aspect.BadRequestT): http.StatusBadRequest
  • "invalid-scopes" (type *aspect.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *aspect.NotImplementedT): http.StatusNotImplemented
  • "not-found" (type *aspect.ResourceNotFoundT): http.StatusNotFound
  • "not-available" (type *aspect.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *aspect.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeRetractResponse

func DecodeRetractResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeRetractResponse returns a decoder for responses returned by the aspect retract endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeRetractResponse may return the following errors:

  • "bad-request" (type *aspect.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *aspect.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *aspect.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *aspect.NotImplementedT): http.StatusNotImplemented
  • "not-available" (type *aspect.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *aspect.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeUpdateResponse

func DecodeUpdateResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeUpdateResponse returns a decoder for responses returned by the aspect update endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeUpdateResponse may return the following errors:

  • "bad-request" (type *aspect.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *aspect.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *aspect.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *aspect.NotImplementedT): http.StatusNotImplemented
  • "not-unique" (type *aspect.NotUniqueResourceT): http.StatusFailedDependency
  • "not-available" (type *aspect.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *aspect.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func EncodeCreateRequest

func EncodeCreateRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeCreateRequest returns an encoder for requests sent to the aspect create server.

func EncodeListRequest

func EncodeListRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListRequest returns an encoder for requests sent to the aspect list server.

func EncodeReadRequest

func EncodeReadRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeReadRequest returns an encoder for requests sent to the aspect read server.

func EncodeRetractRequest

func EncodeRetractRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeRetractRequest returns an encoder for requests sent to the aspect retract server.

func EncodeUpdateRequest

func EncodeUpdateRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeUpdateRequest returns an encoder for requests sent to the aspect update server.

func ListAspectPath

func ListAspectPath() string

ListAspectPath returns the URL path to the aspect service list HTTP endpoint.

func NewCreateAspectIDRTOK

func NewCreateAspectIDRTOK(body *CreateResponseBody) *aspect.AspectIDRT

NewCreateAspectIDRTOK builds a "aspect" service "create" endpoint result from a HTTP "OK" response.

func NewCreateBadRequest

func NewCreateBadRequest(body *CreateBadRequestResponseBody) *aspect.BadRequestT

NewCreateBadRequest builds a aspect service create endpoint bad-request error.

func NewCreateInvalidParameter

func NewCreateInvalidParameter(body *CreateInvalidParameterResponseBody) *aspect.InvalidParameterT

NewCreateInvalidParameter builds a aspect service create endpoint invalid-parameter error.

func NewCreateInvalidScopes

func NewCreateInvalidScopes(body *CreateInvalidScopesResponseBody) *aspect.InvalidScopesT

NewCreateInvalidScopes builds a aspect service create endpoint invalid-scopes error.

func NewCreateNotAuthorized

func NewCreateNotAuthorized() *aspect.UnauthorizedT

NewCreateNotAuthorized builds a aspect service create endpoint not-authorized error.

func NewCreateNotAvailable added in v0.39.0

func NewCreateNotAvailable() *aspect.ServiceNotAvailableT

NewCreateNotAvailable builds a aspect service create endpoint not-available error.

func NewCreateNotImplemented

func NewCreateNotImplemented(body *CreateNotImplementedResponseBody) *aspect.NotImplementedT

NewCreateNotImplemented builds a aspect service create endpoint not-implemented error.

func NewListAspectListRTOK

func NewListAspectListRTOK(body *ListResponseBody) *aspect.AspectListRT

NewListAspectListRTOK builds a "aspect" service "list" endpoint result from a HTTP "OK" response.

func NewListBadRequest

func NewListBadRequest(body *ListBadRequestResponseBody) *aspect.BadRequestT

NewListBadRequest builds a aspect service list endpoint bad-request error.

func NewListInvalidParameter

func NewListInvalidParameter(body *ListInvalidParameterResponseBody) *aspect.InvalidParameterT

NewListInvalidParameter builds a aspect service list endpoint invalid-parameter error.

func NewListInvalidScopes

func NewListInvalidScopes(body *ListInvalidScopesResponseBody) *aspect.InvalidScopesT

NewListInvalidScopes builds a aspect service list endpoint invalid-scopes error.

func NewListNotAuthorized

func NewListNotAuthorized() *aspect.UnauthorizedT

NewListNotAuthorized builds a aspect service list endpoint not-authorized error.

func NewListNotAvailable added in v0.39.0

func NewListNotAvailable() *aspect.ServiceNotAvailableT

NewListNotAvailable builds a aspect service list endpoint not-available error.

func NewListNotImplemented

func NewListNotImplemented(body *ListNotImplementedResponseBody) *aspect.NotImplementedT

NewListNotImplemented builds a aspect service list endpoint not-implemented error.

func NewListUnsupportedContentType

func NewListUnsupportedContentType(body *ListUnsupportedContentTypeResponseBody) *aspect.UnsupportedContentTypeT

NewListUnsupportedContentType builds a aspect service list endpoint unsupported-content-type error.

func NewReadAspectRTOK

func NewReadAspectRTOK(body *ReadResponseBody) *aspect.AspectRT

NewReadAspectRTOK builds a "aspect" service "read" endpoint result from a HTTP "OK" response.

func NewReadBadRequest

func NewReadBadRequest(body *ReadBadRequestResponseBody) *aspect.BadRequestT

NewReadBadRequest builds a aspect service read endpoint bad-request error.

func NewReadInvalidScopes

func NewReadInvalidScopes(body *ReadInvalidScopesResponseBody) *aspect.InvalidScopesT

NewReadInvalidScopes builds a aspect service read endpoint invalid-scopes error.

func NewReadNotAuthorized

func NewReadNotAuthorized() *aspect.UnauthorizedT

NewReadNotAuthorized builds a aspect service read endpoint not-authorized error.

func NewReadNotAvailable added in v0.39.0

func NewReadNotAvailable() *aspect.ServiceNotAvailableT

NewReadNotAvailable builds a aspect service read endpoint not-available error.

func NewReadNotFound

func NewReadNotFound(body *ReadNotFoundResponseBody) *aspect.ResourceNotFoundT

NewReadNotFound builds a aspect service read endpoint not-found error.

func NewReadNotImplemented

func NewReadNotImplemented(body *ReadNotImplementedResponseBody) *aspect.NotImplementedT

NewReadNotImplemented builds a aspect service read endpoint not-implemented error.

func NewRetractBadRequest

func NewRetractBadRequest(body *RetractBadRequestResponseBody) *aspect.BadRequestT

NewRetractBadRequest builds a aspect service retract endpoint bad-request error.

func NewRetractInvalidParameter

func NewRetractInvalidParameter(body *RetractInvalidParameterResponseBody) *aspect.InvalidParameterT

NewRetractInvalidParameter builds a aspect service retract endpoint invalid-parameter error.

func NewRetractInvalidScopes

func NewRetractInvalidScopes(body *RetractInvalidScopesResponseBody) *aspect.InvalidScopesT

NewRetractInvalidScopes builds a aspect service retract endpoint invalid-scopes error.

func NewRetractNotAuthorized

func NewRetractNotAuthorized() *aspect.UnauthorizedT

NewRetractNotAuthorized builds a aspect service retract endpoint not-authorized error.

func NewRetractNotAvailable added in v0.39.0

func NewRetractNotAvailable() *aspect.ServiceNotAvailableT

NewRetractNotAvailable builds a aspect service retract endpoint not-available error.

func NewRetractNotImplemented

func NewRetractNotImplemented(body *RetractNotImplementedResponseBody) *aspect.NotImplementedT

NewRetractNotImplemented builds a aspect service retract endpoint not-implemented error.

func NewUpdateAspectIDRTOK

func NewUpdateAspectIDRTOK(body *UpdateResponseBody) *aspect.AspectIDRT

NewUpdateAspectIDRTOK builds a "aspect" service "update" endpoint result from a HTTP "OK" response.

func NewUpdateBadRequest

func NewUpdateBadRequest(body *UpdateBadRequestResponseBody) *aspect.BadRequestT

NewUpdateBadRequest builds a aspect service update endpoint bad-request error.

func NewUpdateInvalidParameter

func NewUpdateInvalidParameter(body *UpdateInvalidParameterResponseBody) *aspect.InvalidParameterT

NewUpdateInvalidParameter builds a aspect service update endpoint invalid-parameter error.

func NewUpdateInvalidScopes

func NewUpdateInvalidScopes(body *UpdateInvalidScopesResponseBody) *aspect.InvalidScopesT

NewUpdateInvalidScopes builds a aspect service update endpoint invalid-scopes error.

func NewUpdateNotAuthorized

func NewUpdateNotAuthorized() *aspect.UnauthorizedT

NewUpdateNotAuthorized builds a aspect service update endpoint not-authorized error.

func NewUpdateNotAvailable added in v0.39.0

func NewUpdateNotAvailable() *aspect.ServiceNotAvailableT

NewUpdateNotAvailable builds a aspect service update endpoint not-available error.

func NewUpdateNotImplemented

func NewUpdateNotImplemented(body *UpdateNotImplementedResponseBody) *aspect.NotImplementedT

NewUpdateNotImplemented builds a aspect service update endpoint not-implemented error.

func NewUpdateNotUnique added in v0.39.0

func NewUpdateNotUnique(body *UpdateNotUniqueResponseBody) *aspect.NotUniqueResourceT

NewUpdateNotUnique builds a aspect service update endpoint not-unique error.

func ReadAspectPath

func ReadAspectPath(id string) string

ReadAspectPath returns the URL path to the aspect service read HTTP endpoint.

func RetractAspectPath

func RetractAspectPath(id string) string

RetractAspectPath returns the URL path to the aspect service retract HTTP endpoint.

func UpdateAspectPath

func UpdateAspectPath() string

UpdateAspectPath returns the URL path to the aspect service update HTTP endpoint.

func ValidateAspectListItemRTResponseBody

func ValidateAspectListItemRTResponseBody(body *AspectListItemRTResponseBody) (err error)

ValidateAspectListItemRTResponseBody runs the validations defined on AspectListItemRTResponseBody

func ValidateCreateBadRequestResponseBody

func ValidateCreateBadRequestResponseBody(body *CreateBadRequestResponseBody) (err error)

ValidateCreateBadRequestResponseBody runs the validations defined on create_bad-request_response_body

func ValidateCreateInvalidParameterResponseBody

func ValidateCreateInvalidParameterResponseBody(body *CreateInvalidParameterResponseBody) (err error)

ValidateCreateInvalidParameterResponseBody runs the validations defined on create_invalid-parameter_response_body

func ValidateCreateInvalidScopesResponseBody

func ValidateCreateInvalidScopesResponseBody(body *CreateInvalidScopesResponseBody) (err error)

ValidateCreateInvalidScopesResponseBody runs the validations defined on create_invalid-scopes_response_body

func ValidateCreateNotImplementedResponseBody

func ValidateCreateNotImplementedResponseBody(body *CreateNotImplementedResponseBody) (err error)

ValidateCreateNotImplementedResponseBody runs the validations defined on create_not-implemented_response_body

func ValidateCreateResponseBody added in v0.30.0

func ValidateCreateResponseBody(body *CreateResponseBody) (err error)

ValidateCreateResponseBody runs the validations defined on CreateResponseBody

func ValidateLinkTResponseBody added in v0.30.0

func ValidateLinkTResponseBody(body *LinkTResponseBody) (err error)

ValidateLinkTResponseBody runs the validations defined on LinkTResponseBody

func ValidateListBadRequestResponseBody

func ValidateListBadRequestResponseBody(body *ListBadRequestResponseBody) (err error)

ValidateListBadRequestResponseBody runs the validations defined on list_bad-request_response_body

func ValidateListInvalidParameterResponseBody

func ValidateListInvalidParameterResponseBody(body *ListInvalidParameterResponseBody) (err error)

ValidateListInvalidParameterResponseBody runs the validations defined on list_invalid-parameter_response_body

func ValidateListInvalidScopesResponseBody

func ValidateListInvalidScopesResponseBody(body *ListInvalidScopesResponseBody) (err error)

ValidateListInvalidScopesResponseBody runs the validations defined on list_invalid-scopes_response_body

func ValidateListNotImplementedResponseBody

func ValidateListNotImplementedResponseBody(body *ListNotImplementedResponseBody) (err error)

ValidateListNotImplementedResponseBody runs the validations defined on list_not-implemented_response_body

func ValidateListResponseBody added in v0.30.0

func ValidateListResponseBody(body *ListResponseBody) (err error)

ValidateListResponseBody runs the validations defined on ListResponseBody

func ValidateListUnsupportedContentTypeResponseBody

func ValidateListUnsupportedContentTypeResponseBody(body *ListUnsupportedContentTypeResponseBody) (err error)

ValidateListUnsupportedContentTypeResponseBody runs the validations defined on list_unsupported-content-type_response_body

func ValidateReadBadRequestResponseBody

func ValidateReadBadRequestResponseBody(body *ReadBadRequestResponseBody) (err error)

ValidateReadBadRequestResponseBody runs the validations defined on read_bad-request_response_body

func ValidateReadInvalidScopesResponseBody

func ValidateReadInvalidScopesResponseBody(body *ReadInvalidScopesResponseBody) (err error)

ValidateReadInvalidScopesResponseBody runs the validations defined on read_invalid-scopes_response_body

func ValidateReadNotFoundResponseBody

func ValidateReadNotFoundResponseBody(body *ReadNotFoundResponseBody) (err error)

ValidateReadNotFoundResponseBody runs the validations defined on read_not-found_response_body

func ValidateReadNotImplementedResponseBody

func ValidateReadNotImplementedResponseBody(body *ReadNotImplementedResponseBody) (err error)

ValidateReadNotImplementedResponseBody runs the validations defined on read_not-implemented_response_body

func ValidateReadResponseBody added in v0.30.0

func ValidateReadResponseBody(body *ReadResponseBody) (err error)

ValidateReadResponseBody runs the validations defined on ReadResponseBody

func ValidateRetractBadRequestResponseBody

func ValidateRetractBadRequestResponseBody(body *RetractBadRequestResponseBody) (err error)

ValidateRetractBadRequestResponseBody runs the validations defined on retract_bad-request_response_body

func ValidateRetractInvalidParameterResponseBody

func ValidateRetractInvalidParameterResponseBody(body *RetractInvalidParameterResponseBody) (err error)

ValidateRetractInvalidParameterResponseBody runs the validations defined on retract_invalid-parameter_response_body

func ValidateRetractInvalidScopesResponseBody

func ValidateRetractInvalidScopesResponseBody(body *RetractInvalidScopesResponseBody) (err error)

ValidateRetractInvalidScopesResponseBody runs the validations defined on retract_invalid-scopes_response_body

func ValidateRetractNotImplementedResponseBody

func ValidateRetractNotImplementedResponseBody(body *RetractNotImplementedResponseBody) (err error)

ValidateRetractNotImplementedResponseBody runs the validations defined on retract_not-implemented_response_body

func ValidateUpdateBadRequestResponseBody

func ValidateUpdateBadRequestResponseBody(body *UpdateBadRequestResponseBody) (err error)

ValidateUpdateBadRequestResponseBody runs the validations defined on update_bad-request_response_body

func ValidateUpdateInvalidParameterResponseBody

func ValidateUpdateInvalidParameterResponseBody(body *UpdateInvalidParameterResponseBody) (err error)

ValidateUpdateInvalidParameterResponseBody runs the validations defined on update_invalid-parameter_response_body

func ValidateUpdateInvalidScopesResponseBody

func ValidateUpdateInvalidScopesResponseBody(body *UpdateInvalidScopesResponseBody) (err error)

ValidateUpdateInvalidScopesResponseBody runs the validations defined on update_invalid-scopes_response_body

func ValidateUpdateNotImplementedResponseBody

func ValidateUpdateNotImplementedResponseBody(body *UpdateNotImplementedResponseBody) (err error)

ValidateUpdateNotImplementedResponseBody runs the validations defined on update_not-implemented_response_body

func ValidateUpdateNotUniqueResponseBody added in v0.39.0

func ValidateUpdateNotUniqueResponseBody(body *UpdateNotUniqueResponseBody) (err error)

ValidateUpdateNotUniqueResponseBody runs the validations defined on update_not-unique_response_body

func ValidateUpdateResponseBody added in v0.30.0

func ValidateUpdateResponseBody(body *UpdateResponseBody) (err error)

ValidateUpdateResponseBody runs the validations defined on UpdateResponseBody

Types

type AspectListItemRTResponseBody

type AspectListItemRTResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Entity URN
	Entity *string `form:"entity,omitempty" json:"entity,omitempty" xml:"entity,omitempty"`
	// Schema URN
	Schema *string `form:"schema,omitempty" json:"schema,omitempty" xml:"schema,omitempty"`
	// Attached aspect aspect
	Content any `form:"content,omitempty" json:"content,omitempty" xml:"content,omitempty"`
	// Content-Type header, MUST be of application/json.
	ContentType *string `json:"content-type,omitempty"`
	// Time this assertion became valid
	ValidFrom *string `form:"valid-from,omitempty" json:"valid-from,omitempty" xml:"valid-from,omitempty"`
	// Time this assertion became valid
	ValidTo *string `form:"valid-to,omitempty" json:"valid-to,omitempty" xml:"valid-to,omitempty"`
}

AspectListItemRTResponseBody is used to define fields on response body types.

type Client

type Client struct {
	// Read Doer is the HTTP client used to make requests to the read endpoint.
	ReadDoer goahttp.Doer

	// List Doer is the HTTP client used to make requests to the list endpoint.
	ListDoer goahttp.Doer

	// Create Doer is the HTTP client used to make requests to the create endpoint.
	CreateDoer goahttp.Doer

	// Update Doer is the HTTP client used to make requests to the update endpoint.
	UpdateDoer goahttp.Doer

	// Retract Doer is the HTTP client used to make requests to the retract
	// endpoint.
	RetractDoer goahttp.Doer

	// CORS Doer is the HTTP client used to make requests to the  endpoint.
	CORSDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the aspect service endpoint HTTP clients.

func NewClient

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the aspect service servers.

func (*Client) BuildCreateRequest

func (c *Client) BuildCreateRequest(ctx context.Context, v any) (*http.Request, error)

BuildCreateRequest instantiates a HTTP request object with method and path set to call the "aspect" service "create" endpoint

func (*Client) BuildListRequest

func (c *Client) BuildListRequest(ctx context.Context, v any) (*http.Request, error)

BuildListRequest instantiates a HTTP request object with method and path set to call the "aspect" service "list" endpoint

func (*Client) BuildReadRequest

func (c *Client) BuildReadRequest(ctx context.Context, v any) (*http.Request, error)

BuildReadRequest instantiates a HTTP request object with method and path set to call the "aspect" service "read" endpoint

func (*Client) BuildRetractRequest

func (c *Client) BuildRetractRequest(ctx context.Context, v any) (*http.Request, error)

BuildRetractRequest instantiates a HTTP request object with method and path set to call the "aspect" service "retract" endpoint

func (*Client) BuildUpdateRequest

func (c *Client) BuildUpdateRequest(ctx context.Context, v any) (*http.Request, error)

BuildUpdateRequest instantiates a HTTP request object with method and path set to call the "aspect" service "update" endpoint

func (*Client) Create

func (c *Client) Create() goa.Endpoint

Create returns an endpoint that makes HTTP requests to the aspect service create server.

func (*Client) List

func (c *Client) List() goa.Endpoint

List returns an endpoint that makes HTTP requests to the aspect service list server.

func (*Client) Read

func (c *Client) Read() goa.Endpoint

Read returns an endpoint that makes HTTP requests to the aspect service read server.

func (*Client) Retract

func (c *Client) Retract() goa.Endpoint

Retract returns an endpoint that makes HTTP requests to the aspect service retract server.

func (*Client) Update

func (c *Client) Update() goa.Endpoint

Update returns an endpoint that makes HTTP requests to the aspect service update server.

type CreateBadRequestResponseBody

type CreateBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateBadRequestResponseBody is the type of the "aspect" service "create" endpoint HTTP response body for the "bad-request" error.

type CreateInvalidParameterResponseBody

type CreateInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

CreateInvalidParameterResponseBody is the type of the "aspect" service "create" endpoint HTTP response body for the "invalid-parameter" error.

type CreateInvalidScopesResponseBody

type CreateInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateInvalidScopesResponseBody is the type of the "aspect" service "create" endpoint HTTP response body for the "invalid-scopes" error.

type CreateNotImplementedResponseBody

type CreateNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

CreateNotImplementedResponseBody is the type of the "aspect" service "create" endpoint HTTP response body for the "not-implemented" error.

type CreateResponseBody

type CreateResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

CreateResponseBody is the type of the "aspect" service "create" endpoint HTTP response body.

type LinkTResponseBody added in v0.30.0

type LinkTResponseBody struct {
	// relation type
	Rel *string `form:"rel,omitempty" json:"rel,omitempty" xml:"rel,omitempty"`
	// mime type
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// web link
	Href *string `form:"href,omitempty" json:"href,omitempty" xml:"href,omitempty"`
}

LinkTResponseBody is used to define fields on response body types.

type ListBadRequestResponseBody

type ListBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListBadRequestResponseBody is the type of the "aspect" service "list" endpoint HTTP response body for the "bad-request" error.

type ListInvalidParameterResponseBody

type ListInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ListInvalidParameterResponseBody is the type of the "aspect" service "list" endpoint HTTP response body for the "invalid-parameter" error.

type ListInvalidScopesResponseBody

type ListInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListInvalidScopesResponseBody is the type of the "aspect" service "list" endpoint HTTP response body for the "invalid-scopes" error.

type ListNotImplementedResponseBody

type ListNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListNotImplementedResponseBody is the type of the "aspect" service "list" endpoint HTTP response body for the "not-implemented" error.

type ListResponseBody

type ListResponseBody struct {
	// List of aspect descriptions
	Items []*AspectListItemRTResponseBody `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	// Entity for which to request aspect
	Entity *string `form:"entity,omitempty" json:"entity,omitempty" xml:"entity,omitempty"`
	// Optional schema to filter on
	Schema *string `form:"schema,omitempty" json:"schema,omitempty" xml:"schema,omitempty"`
	// Optional json path to further filter on returned list
	AspectPath *string `form:"aspect-path,omitempty" json:"aspect-path,omitempty" xml:"aspect-path,omitempty"`
	// Time at which this list was valid
	AtTime *string              `form:"at-time,omitempty" json:"at-time,omitempty" xml:"at-time,omitempty"`
	Links  []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

ListResponseBody is the type of the "aspect" service "list" endpoint HTTP response body.

type ListUnsupportedContentTypeResponseBody

type ListUnsupportedContentTypeResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ListUnsupportedContentTypeResponseBody is the type of the "aspect" service "list" endpoint HTTP response body for the "unsupported-content-type" error.

type ReadBadRequestResponseBody

type ReadBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadBadRequestResponseBody is the type of the "aspect" service "read" endpoint HTTP response body for the "bad-request" error.

type ReadInvalidScopesResponseBody

type ReadInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadInvalidScopesResponseBody is the type of the "aspect" service "read" endpoint HTTP response body for the "invalid-scopes" error.

type ReadNotFoundResponseBody

type ReadNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadNotFoundResponseBody is the type of the "aspect" service "read" endpoint HTTP response body for the "not-found" error.

type ReadNotImplementedResponseBody

type ReadNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ReadNotImplementedResponseBody is the type of the "aspect" service "read" endpoint HTTP response body for the "not-implemented" error.

type ReadResponseBody

type ReadResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Entity URN
	Entity *string `form:"entity,omitempty" json:"entity,omitempty" xml:"entity,omitempty"`
	// Schema URN
	Schema *string `form:"schema,omitempty" json:"schema,omitempty" xml:"schema,omitempty"`
	// Description of aspect encoded as 'content-type'
	Content any `form:"content,omitempty" json:"content,omitempty" xml:"content,omitempty"`
	// Content-Type header, MUST be of application/json.
	ContentType *string `json:"content-type,omitempty"`
	// Time this record was asserted
	ValidFrom *string `form:"valid-from,omitempty" json:"valid-from,omitempty" xml:"valid-from,omitempty"`
	// Time this record was retracted
	ValidTo *string `form:"valid-to,omitempty" json:"valid-to,omitempty" xml:"valid-to,omitempty"`
	// Entity asserting this metadata record at 'valid-from'
	Asserter *string `form:"asserter,omitempty" json:"asserter,omitempty" xml:"asserter,omitempty"`
	// Entity retracting this record at 'valid-to'
	Retracter *string `form:"retracter,omitempty" json:"retracter,omitempty" xml:"retracter,omitempty"`
	// Reference to retracted aspect record this record is replacing
	Replaces *string `form:"replaces,omitempty" json:"replaces,omitempty" xml:"replaces,omitempty"`
	// Reference to billable account
	Account *string `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	// Reference to policy used
	Policy *string              `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	Links  []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

ReadResponseBody is the type of the "aspect" service "read" endpoint HTTP response body.

type RetractBadRequestResponseBody

type RetractBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

RetractBadRequestResponseBody is the type of the "aspect" service "retract" endpoint HTTP response body for the "bad-request" error.

type RetractInvalidParameterResponseBody

type RetractInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

RetractInvalidParameterResponseBody is the type of the "aspect" service "retract" endpoint HTTP response body for the "invalid-parameter" error.

type RetractInvalidScopesResponseBody

type RetractInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

RetractInvalidScopesResponseBody is the type of the "aspect" service "retract" endpoint HTTP response body for the "invalid-scopes" error.

type RetractNotImplementedResponseBody

type RetractNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

RetractNotImplementedResponseBody is the type of the "aspect" service "retract" endpoint HTTP response body for the "not-implemented" error.

type UpdateBadRequestResponseBody

type UpdateBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateBadRequestResponseBody is the type of the "aspect" service "update" endpoint HTTP response body for the "bad-request" error.

type UpdateInvalidParameterResponseBody

type UpdateInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

UpdateInvalidParameterResponseBody is the type of the "aspect" service "update" endpoint HTTP response body for the "invalid-parameter" error.

type UpdateInvalidScopesResponseBody

type UpdateInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateInvalidScopesResponseBody is the type of the "aspect" service "update" endpoint HTTP response body for the "invalid-scopes" error.

type UpdateNotImplementedResponseBody

type UpdateNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateNotImplementedResponseBody is the type of the "aspect" service "update" endpoint HTTP response body for the "not-implemented" error.

type UpdateNotUniqueResponseBody added in v0.39.0

type UpdateNotUniqueResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

UpdateNotUniqueResponseBody is the type of the "aspect" service "update" endpoint HTTP response body for the "not-unique" error.

type UpdateResponseBody

type UpdateResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
}

UpdateResponseBody is the type of the "aspect" service "update" endpoint HTTP response body.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳