gateway

Documentation

Overview

Package gateway provides pz-gateway helper functions.

Index

• Constants
• func RegisterService(m ResourceMetadata) error
• type JobMsg
• type ResourceMetadata

Constants

const GatewayJobURL = "http://pz-gateway.cf.piazzageo.io/job"

GatewayJobURL is the Piazza registration endpoint

Functions

func RegisterService

func RegisterService(m ResourceMetadata) error

RegisterService handles service registartion with Piazza for external services.

Types

type JobMsg

type JobMsg struct {
	Type  string `json:"type"`
	JobID string `json:"jobId"`
}

JobMsg defines the expected output JSON returned by Piazza when an external service is registered.

type ResourceMetadata

type ResourceMetadata struct {
	Name             string `json:"name"`
	Description      string `json:"description"`
	URL              string `json:"url"`
	Method           string `json:"method,omitempty"`
	RequestMimeType  string `json:"requestMimeType,omitempty"`
	ResponseMimeType string `json:"responseMimeType,omitempty"`
	Params           string `json:"params,omitempty"`
}

ResourceMetadata defines the metadata required to register the service.