api

package

v0.4.0 Latest Latest Go to latest Published: Jan 19, 2024 License: MPL-2.0 Imports: 35 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/hashicorp-forge/hermes

Links

Open Source Insights

Documentation ¶

Index ¶

func AnalyticsHandler(log hclog.Logger) http.Handler
func ApprovalHandler(cfg *config.Config, l hclog.Logger, ar *algolia.Client, aw *algolia.Client, ...) http.Handler
func DocumentHandler(cfg *config.Config, l hclog.Logger, ar *algolia.Client, aw *algolia.Client, ...) http.Handler
func DocumentTypesHandler(cfg config.Config, log hclog.Logger) http.Handler
func DraftsDocumentHandler(cfg *config.Config, l hclog.Logger, ar *algolia.Client, aw *algolia.Client, ...) http.Handler
func DraftsHandler(cfg *config.Config, l hclog.Logger, ar *algolia.Client, aw *algolia.Client, ...) http.Handler
func MeHandler(l hclog.Logger, s *gw.Service) http.Handler
func MeRecentlyViewedDocsHandler(cfg *config.Config, l hclog.Logger, db *gorm.DB) http.Handler
func MeSubscriptionsHandler(cfg *config.Config, l hclog.Logger, s *gw.Service, db *gorm.DB) http.Handler
func PeopleDataHandler(cfg *config.Config, log hclog.Logger, s *gw.Service) http.Handler
func ProductsHandler(cfg *config.Config, a *algolia.Client, log hclog.Logger) http.Handler
func ReviewHandler(cfg *config.Config, l hclog.Logger, ar *algolia.Client, aw *algolia.Client, ...) http.Handler
type AnalyticsRequest
type AnalyticsResponse
type DocumentPatchRequest
type DraftsPatchRequest
type DraftsRequest
type DraftsResponse
type MeGetResponse
type MeSubscriptionsPostRequest
type PeopleDataRequest

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AnalyticsHandler ¶

func AnalyticsHandler(log hclog.Logger) http.Handler

Analytics handles user events for analytics

func ApprovalHandler ¶

func ApprovalHandler(
	cfg *config.Config,
	l hclog.Logger,
	ar *algolia.Client,
	aw *algolia.Client,
	s *gw.Service,
	db *gorm.DB) http.Handler

func DocumentHandler ¶

func DocumentHandler(
	cfg *config.Config,
	l hclog.Logger,
	ar *algolia.Client,
	aw *algolia.Client,
	s *gw.Service,
	db *gorm.DB) http.Handler

func DocumentTypesHandler ¶

func DocumentTypesHandler(cfg config.Config, log hclog.Logger) http.Handler

func DraftsDocumentHandler ¶

func DraftsDocumentHandler(
	cfg *config.Config,
	l hclog.Logger,
	ar *algolia.Client,
	aw *algolia.Client,
	s *gw.Service,
	db *gorm.DB) http.Handler

func DraftsHandler ¶

func DraftsHandler(
	cfg *config.Config,
	l hclog.Logger,
	ar *algolia.Client,
	aw *algolia.Client,
	s *gw.Service,
	db *gorm.DB) http.Handler

func MeHandler ¶ added in v0.1.0

func MeHandler(
	l hclog.Logger,
	s *gw.Service,
) http.Handler

func MeRecentlyViewedDocsHandler ¶ added in v0.1.0

func MeRecentlyViewedDocsHandler(
	cfg *config.Config,
	l hclog.Logger,
	db *gorm.DB,
) http.Handler

func MeSubscriptionsHandler ¶

func MeSubscriptionsHandler(
	cfg *config.Config,
	l hclog.Logger,
	s *gw.Service,
	db *gorm.DB,
) http.Handler

func PeopleDataHandler ¶

func PeopleDataHandler(
	cfg *config.Config,
	log hclog.Logger,
	s *gw.Service) http.Handler

PeopleDataHandler returns people related data from the Google API to the Hermes frontend.

func ProductsHandler ¶

func ProductsHandler(cfg *config.Config, a *algolia.Client, log hclog.Logger) http.Handler

ProductsHandler returns the product mappings to the Hermes frontend.

func ReviewHandler ¶

func ReviewHandler(
	cfg *config.Config,
	l hclog.Logger,
	ar *algolia.Client,
	aw *algolia.Client,
	s *gw.Service,
	db *gorm.DB,
) http.Handler

Types ¶

type AnalyticsRequest ¶

type AnalyticsRequest struct {
	DocumentID  string `json:"document_id"`
	ProductName string `json:"product_name"`
}

type AnalyticsResponse ¶

type AnalyticsResponse struct {
	Recorded bool `json:"recorded"`
}

type DocumentPatchRequest ¶

type DocumentPatchRequest struct {
	Approvers    *[]string               `json:"approvers,omitempty"`
	Contributors *[]string               `json:"contributors,omitempty"`
	CustomFields *[]document.CustomField `json:"customFields,omitempty"`
	Status       *string                 `json:"status,omitempty"`
	Summary      *string                 `json:"summary,omitempty"`
	// Tags                []string `json:"tags,omitempty"`
	Title *string `json:"title,omitempty"`
}

DocumentPatchRequest contains a subset of documents fields that are allowed to be updated with a PATCH request.

type DraftsPatchRequest ¶

type DraftsPatchRequest struct {
	Approvers    *[]string               `json:"approvers,omitempty"`
	Contributors *[]string               `json:"contributors,omitempty"`
	CustomFields *[]document.CustomField `json:"customFields,omitempty"`
	Product      *string                 `json:"product,omitempty"`
	Summary      *string                 `json:"summary,omitempty"`
	// Tags                []string `json:"tags,omitempty"`
	Title *string `json:"title,omitempty"`
}

DraftsPatchRequest contains a subset of drafts fields that are allowed to be updated with a PATCH request.

type DraftsRequest ¶

type DraftsRequest struct {
	Approvers           []string `json:"approvers,omitempty"`
	Contributors        []string `json:"contributors,omitempty"`
	DocType             string   `json:"docType,omitempty"`
	Product             string   `json:"product,omitempty"`
	ProductAbbreviation string   `json:"productAbbreviation,omitempty"`
	Summary             string   `json:"summary,omitempty"`
	Tags                []string `json:"tags,omitempty"`
	Title               string   `json:"title"`
}

type DraftsResponse ¶

type DraftsResponse struct {
	ID string `json:"id"`
}

type MeGetResponse ¶ added in v0.1.0

type MeGetResponse struct {
	ID            string `json:"id"`
	Email         string `json:"email"`
	VerifiedEmail bool   `json:"verified_email"`
	Name          string `json:"name"`
	GivenName     string `json:"given_name"`
	FamilyName    string `json:"family_name"`
	Picture       string `json:"picture"`
	Locale        string `json:"locale,omitempty"`
	HD            string `json:"hd,omitempty"`
}

MeGetResponse mimics the response from Google's `userinfo/me` API (https://www.googleapis.com/userinfo/v2/me).

type MeSubscriptionsPostRequest ¶

type MeSubscriptionsPostRequest struct {
	Subscriptions []string `json:"subscriptions"`
}

type PeopleDataRequest ¶

type PeopleDataRequest struct {
	Query string `json:"query,omitempty"`
}

PeopleDataRequest contains the fields that are allowed to make the POST request.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
v2

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