package
0.0.0-20240930190013-edac6e9229d7
Repository: https://github.com/gokrazy/gokapi.git
Documentation: pkg.go.dev
# README
Go API client for swagger
OpenAPI for GUS (gokrazy update service)
Overview
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version: 1.4.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen
Installation
Put the package under your project folder and add the following in import:
import "./swagger"
Documentation for API Endpoints
All URIs are relative to https://gus.gokrazy.org/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| HeartbeatApi | Heartbeat | Post /heartbeat | device sends a heartbeat |
| IngestApi | Ingest | Post /ingest | ingest a gokrazy build into the GUS database |
| IngestApi | Push | Put /push | push a gokrazy build into the local disk registry |
| UpdateApi | Attempt | Post /attempt | note that an update will be attempted |
| UpdateApi | Update | Post /update | check if an update is available |
Documentation For Models
- AttemptRequest
- AttemptResponse
- HeartbeatRequest
- HeartbeatRequestHumanReadable
- HeartbeatRequestSbom
- HeartbeatResponse
- IngestRequest
- IngestResponse
- PathHash
- PushResponse
- UpdateRequest
- UpdateResponse
Documentation For Authorization
Endpoints do not require authorization.
Author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
# Structs
APIClient manages communication with the GUS (gokrazy update service) API v1.4.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
TODO.
TODO.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author