endpoint

Documentation

Overview

Package endpoint resolves public Drupal service endpoints from sitectl ingress route catalogs.

Index

• Constants
• func Provider() plugin.IngressRouteProvider
• type Resolution
• type Resolved
  • func JSONAPI(cmd *cobra.Command, ctx *config.Context) (Resolved, error)

Constants

const (
	ResolutionTraefik = plugin.IngressRouteResolutionTraefik
	ResolutionCatalog = plugin.IngressRouteResolutionCatalog
)

const (
	// JSONAPIRoute is Drupal's public JSON:API endpoint route name.
	JSONAPIRoute = "jsonapi"
)

Functions

func Provider

func Provider() plugin.IngressRouteProvider

Provider returns the Drupal ingress route provider shared by route discovery and JSON:API endpoint resolution.

Types

type Resolution

type Resolution = plugin.IngressRouteResolution

Resolution identifies the route source selected for an endpoint.

type Resolved

type Resolved = plugin.ResolvedIngressRoute

Resolved pairs a plugin-owned route with its public URL.

func JSONAPI

func JSONAPI(cmd *cobra.Command, ctx *config.Context) (Resolved, error)

JSONAPI resolves Drupal's public JSON:API root for a sitectl context.