Skip to content

OperationsApi.md

Latest commit

 

History

History
101 lines (66 loc) · 3.51 KB

OperationsApi.md

File metadata and controls

101 lines (66 loc) · 3.51 KB
Raw

{{classname}}

All URIs are relative to http://localhost:4567

Method HTTP request Description
OperationsGet Get /operations All operations of Icarus
OperationsOperationIdGet Get /operations/{operationId} gets operation by its ID
OperationsPost Post /operations Submits an operation to this Sidecar

OperationsGet

[]Object OperationsGet(ctx, optional) All operations of Icarus

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *OperationsApiOperationsGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OperationsApiOperationsGetOpts struct

Name Type Description Notes
type_ optional.Interface of []string type of operations to filter on
status optional.Interface of []string status of operations to filter on

Return type

[]Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperationsOperationIdGet

InlineResponse200 OperationsOperationIdGet(ctx, operationId) gets operation by its ID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operationId string ID of operation to return

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperationsPost

InlineResponse200 OperationsPost(ctx, optional) Submits an operation to this Sidecar

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *OperationsApiOperationsPostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OperationsApiOperationsPostOpts struct

Name Type Description Notes
body optional.Interface of Body

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]