Categorygithub.com/tiny-systems/platform-api
modulepackage
0.0.10
Repository: https://github.com/tiny-systems/platform-api.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
14
Dependents
1
Files
696 SLOC

# README

Tiny Systems Public API

Open API specifications, auto generated client and gorilla mux handlers.

  • Healthcheck
  • Webhook endpoints
  • Developer API
go generate ./...

# Functions

GetSwagger returns the Swagger specification corresponding to the generated code in this file.
Handler creates http.Handler with routing matching OpenAPI spec.
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
No description provided by the author
HandlerWithOptions creates http.Handler with additional options.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewHealthCheckRequest generates requests for HealthCheck.
NewPublishModuleRequest calls the generic PublishModule builder with application/json body.
NewPublishModuleRequestWithBody generates requests for PublishModule with any type of body.
NewUpdateModuleVersionRequest calls the generic UpdateModuleVersion builder with application/json body.
NewUpdateModuleVersionRequestWithBody generates requests for UpdateModuleVersion with any type of body.
ParseHealthCheckResponse parses an HTTP response from a HealthCheckWithResponse call.
ParsePublishModuleResponse parses an HTTP response from a PublishModuleWithResponse call.
ParseUpdateModuleVersionResponse parses an HTTP response from a UpdateModuleVersionWithResponse call.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
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

BuildPushOptions defines model for BuildPushOptions.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
No description provided by the author
No description provided by the author
No description provided by the author
PublishComponent defines model for PublishComponent.
PublishModuleRequest defines model for PublishModuleRequest.
No description provided by the author
PublishModuleResult defines model for PublishModuleResult.
PublishModuleVersion defines model for PublishModuleVersion.
No description provided by the author
No description provided by the author
ServerInterfaceWrapper converts contexts to parameters.
No description provided by the author
No description provided by the author
No description provided by the author
UpdateModuleVersionRequest defines model for UpdateModuleVersionRequest.
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.
ServerInterface represents all server handlers.

# Type aliases

ClientOption allows setting custom parameters during construction.
No description provided by the author
PublishModuleJSONRequestBody defines body for PublishModule for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.
UpdateModuleVersionJSONRequestBody defines body for UpdateModuleVersion for application/json ContentType.