package
1.10.0
Repository: https://github.com/snyk/code-client-go.git
Documentation: pkg.go.dev

# Packages

Package v20240216 provides primitives to interact with the openapi HTTP API.
Package v20240216 provides primitives to interact with the openapi HTTP API.
Package v20240216 provides primitives to interact with the openapi HTTP API.

# Functions

Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateFindingsUrlRequestWithApplicationVndAPIPlusJSONBody calls the generic CreateFindingsUrl builder with application/vnd.api+json body.
NewCreateFindingsUrlRequestWithBody generates requests for CreateFindingsUrl with any type of body.
NewCreateScanWorkspaceJobForUserRequestWithApplicationVndAPIPlusJSONBody calls the generic CreateScanWorkspaceJobForUser builder with application/vnd.api+json body.
NewCreateScanWorkspaceJobForUserRequestWithBody generates requests for CreateScanWorkspaceJobForUser with any type of body.
NewCreateScanWorkspaceJobInternalRequestWithApplicationVndAPIPlusJSONBody calls the generic CreateScanWorkspaceJobInternal builder with application/vnd.api+json body.
NewCreateScanWorkspaceJobInternalRequestWithBody generates requests for CreateScanWorkspaceJobInternal with any type of body.
NewGetScanWorkspaceJobForUserRequest generates requests for GetScanWorkspaceJobForUser.
NewGetScanWorkspaceJobInternalRequest generates requests for GetScanWorkspaceJobInternal.
ParseCreateFindingsUrlResponse parses an HTTP response from a CreateFindingsUrlWithResponse call.
ParseCreateScanWorkspaceJobForUserResponse parses an HTTP response from a CreateScanWorkspaceJobForUserWithResponse call.
ParseCreateScanWorkspaceJobInternalResponse parses an HTTP response from a CreateScanWorkspaceJobInternalWithResponse call.
ParseGetScanWorkspaceJobForUserResponse parses an HTTP response from a GetScanWorkspaceJobForUserWithResponse call.
ParseGetScanWorkspaceJobInternalResponse parses an HTTP response from a GetScanWorkspaceJobInternalWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

No description provided by the author

# Structs

Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
CreateFindingsUrlParams defines parameters for CreateFindingsUrl.
No description provided by the author
CreateScanWorkspaceJobForUserParams defines parameters for CreateScanWorkspaceJobForUser.
No description provided by the author
CreateScanWorkspaceJobInternalParams defines parameters for CreateScanWorkspaceJobInternal.
No description provided by the author
GetScanWorkspaceJobForUserParams defines parameters for GetScanWorkspaceJobForUser.
No description provided by the author
GetScanWorkspaceJobInternalParams defines parameters for GetScanWorkspaceJobInternal.
No description provided by the author

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.

# Type aliases

ClientOption allows setting custom parameters during construction.
CreateFindingsUrlApplicationVndAPIPlusJSONRequestBody defines body for CreateFindingsUrl for application/vnd.api+json ContentType.
CreateScanWorkspaceJobForUserApplicationVndAPIPlusJSONRequestBody defines body for CreateScanWorkspaceJobForUser for application/vnd.api+json ContentType.
CreateScanWorkspaceJobInternalApplicationVndAPIPlusJSONRequestBody defines body for CreateScanWorkspaceJobInternal for application/vnd.api+json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.