package
0.0.0-20250403150915-169f9a4308f2
Repository: https://github.com/osbuild/osbuild-composer.git
Documentation: pkg.go.dev
# Functions
CancelComposeV0 cancels one composes based on the uuid.
DeleteBlueprintV0 deletes the named blueprint and returns an APIResponse.
DeleteComposeV0 deletes one or more composes based on their uuid.
DeleteRaw sends a DELETE request Errors from the API are returned as an APIResponse, client errors are returned as error.
DeleteSourceV0 deletes the named source and returns an APIResponse.
DeleteSourceV1 deletes the named source and returns an APIResponse.
DeleteWorkspaceV0 deletes the named blueprint's workspace and returns an APIResponse.
DepsolveBlueprintV0 depsolves the listed blueprint.
DepsolveProjectsV0 returns the dependencies of the names projects.
FreezeBlueprintV0 depsolves the listed blueprint and returns the blueprint with frozen package versions.
GetBlueprintChangeV1 returns a specific blueprint change.
GetBlueprintInfoTOMLV0 returns the requested blueprint as a TOML string.
GetBlueprintsChangesV0 returns the changes to the listed blueprints.
GetBlueprintsInfoJSONV0 returns the requested blueprints and their changed state.
GetComposeInfoV0 returns detailed information about the selected compose.
GetComposeQueueV0 returns the list of composes in the queue.
GetComposeStatusV0 returns a list of composes matching the optional filter parameters.
GetComposeTypesV0 returns a list of the failed composes.
GetFailedComposesV0 returns a list of the failed composes.
GetFinishedComposesV0 returns a list of the finished composes.
GetJSONAll returns all JSON results from a GET request using offset/limit This function makes 2 requests, the first with limit=0 to get the total number of results, and then with limit=TOTAL to fetch all of the results.
GetModulesInfoV0 returns detailed module info on the named modules.
GetProjectsInfoV0 returns detailed project info on the named projects.
GetRaw returns raw data from a GET request Errors from the API are returned as an APIResponse, client errors are returned as error.
GetRawBody returns the resp.Body io.ReadCloser to the caller NOTE: The caller is responsible for closing the Body when finished.
GetSourceInfoV0 returns detailed information on the named sources.
GetSourceInfoV1 returns detailed information on the named sources.
GetStatusV0 makes a GET request to /api/status and returns the v0 response as a StatusResponseV0.
ListAllModulesV0 returns a list of all the available module names.
ListAllProjectsV0 returns a list of all the available project names.
ListBlueprintsV0 returns a list of blueprint names.
ListModulesV0 returns a list of all the available modules names.
ListSomeModulesV0 returns a list of all the available modules names.
ListSomeProjectsV0 returns a list of all the available project names.
ListSourcesV0 returns a list of source names.
ListSourcesV1 returns a list of source ids.
NewAPIResponse converts the response body to a status response.
NewComposeResponseV0 converts the response body to a status response.
PostComposeV0 sends a JSON compose string to the API and returns an APIResponse.
PostJSON sends a POST with JSON data and the Content-Type header set to "application/json" Errors from the API are returned as an APIResponse, client errors are returned as error.
PostJSONBlueprintV0 sends a JSON blueprint string to the API and returns an APIResponse.
PostJSONSourceV0 sends a JSON source string to the API and returns an APIResponse.
PostJSONSourceV1 sends a JSON source string to the API and returns an APIResponse.
PostJSONWorkspaceV0 sends a JSON blueprint string to the API and returns an APIResponse.
PostRaw sends a POST with raw data and returns the raw response body Errors from the API are returned as an APIResponse, client errors are returned as error.
PostTOML sends a POST with TOML data and the Content-Type header set to "text/x-toml" Errors from the API are returned as an APIResponse, client errors are returned as error.
PostTOMLBlueprintV0 sends a TOML blueprint string to the API and returns an APIResponse.
PostTOMLSourceV0 sends a TOML source string to the API and returns an APIResponse.
PostTOMLSourceV1 sends a TOML source string to the API and returns an APIResponse.
PostTOMLWorkspaceV0 sends a TOML blueprint string to the API and returns an APIResponse.
Request handles sending the request, handling errors, returning the response socket is the path to a Unix Domain socket path is the full URL path, including query strings body is the data to send with POST headers is a map of header:value to add to the request
If it is successful a http.Response will be returned.
TagBlueprintV0 tags the current blueprint commit as a new revision.
UndoBlueprintChangeV0 reverts a blueprint to a previous commit.
WriteComposeImageV0 requests the image for a compose and writes it to an io.Writer.
WriteComposeLogsV0 requests the logs for a compose and writes it to an io.Writer.
WriteComposeLogV0 requests the log for a compose and writes it to an io.Writer.
WriteComposeMetadataV0 requests the metadata for a compose and writes it to an io.Writer.
WriteComposeResultsV0 requests the results for a compose and writes it to an io.Writer.
# Structs
APIErrorMsg is an individual API error with an ID and a message string.
APIResponse is returned by some requests to indicate success or failure.
No description provided by the author