getspot

Documentation

Index

• Variables
• type GetSpotRequest
• type GetSpotResponse
  • func GetSpot(ctx context.Context, request GetSpotRequest, odsDB db.DB) (GetSpotResponse, *errors.ODSError)

Variables

var GetSpotMeta = endpointdef.New(
	"getSpotDetails",
	"/spots/{"+endpoints.ParamSpotName+"}",
	http.MethodGet,
	http.StatusOK,
)

GetSpotMeta holds the endpoint information

Types

type GetSpotRequest

type GetSpotRequest struct {
	SpotName string `json:"spotName"`
}

GetSpotRequest is the request structure

type GetSpotResponse

type GetSpotResponse spot.Details

GetSpotResponse holds the response structure

func GetSpot

func GetSpot(ctx context.Context, request GetSpotRequest, odsDB db.DB) (GetSpotResponse, *errors.ODSError)

GetSpot returns all the details on a given spot