serve

package

v0.3.11 Latest Latest Go to latest Published: Jul 28, 2023 License: AGPL-3.0, BSD-2-Clause, ISC Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/practable/book

Links

Open Source Insights

Documentation ¶

Overview ¶

Package booking provides an API for booking experiments

Index ¶

func API(ctx context.Context, config config.ServerConfig, cancelOthers func())
type Permission

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func API ¶

func API(ctx context.Context, config config.ServerConfig, cancelOthers func())

API starts the API Inputs @closed - channel will be closed when server shutsdown @wg - waitgroup, we must wg.Done() when we are shutdown @port - where to listen locally @host - external FQDN of the host (for checking against tokens) e.g. https://relay-access.practable.io @target - FQDN of the relay instance e.g. wss://relay.practable.io @secret- HMAC shared secret which incoming tokens will be signed with @cs - pointer to the CodeStore this API shares with the shellbar websocket relay @options - for future backwards compatibility (no options currently available)

Types ¶

type Permission ¶

type Permission struct {
	BookingID string   `json:"booking_id"`
	Topic     string   `json:"topic"`
	Prefix    string   `json:"prefix"`
	Scopes    []string `json:"scopes"`
	jwt.RegisteredClaims
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
models
restapi Package restapi AdvanceBooking	Package restapi AdvanceBooking
operations
operations/admin
operations/users

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL