mirror of
https://github.com/open-policy-agent/opa.git
synced 2026-08-12 19:32:48 -06:00
Johan Fylling
a179a24c48
All packages, except for `cmd` and `internal`, have been moved into a new `v1` root package. Old packages are kept for backwards-compatibility reasons. All contained code is replaced with simple type aliases and proxy functions to `v1` implementations. Old packages default to the Rego v0 syntax, new `v1` packages default to the Rego v1 syntax. Signed-off-by: Johan Fylling <johan.dev@fylling.se>
55 lines
1.8 KiB
Go
55 lines
1.8 KiB
Go
// Copyright 2018 The OPA Authors. All rights reserved.
|
|
// Use of this source code is governed by an Apache2
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// Package rest implements a REST client for communicating with remote services.
|
|
package rest
|
|
|
|
import (
|
|
"github.com/open-policy-agent/opa/logging"
|
|
"github.com/open-policy-agent/opa/v1/keys"
|
|
v1 "github.com/open-policy-agent/opa/v1/plugins/rest"
|
|
"github.com/open-policy-agent/opa/v1/tracing"
|
|
)
|
|
|
|
// An HTTPAuthPlugin represents a mechanism to construct and configure HTTP authentication for a REST service
|
|
type HTTPAuthPlugin = v1.HTTPAuthPlugin
|
|
|
|
// Config represents configuration for a REST client.
|
|
type Config = v1.Config
|
|
|
|
// An AuthPluginLookupFunc can lookup auth plugins by their name.
|
|
type AuthPluginLookupFunc = v1.AuthPluginLookupFunc
|
|
|
|
// Client implements an HTTP/REST client for communicating with remote
|
|
// services.
|
|
type Client = v1.Client
|
|
|
|
// Name returns an option that overrides the service name on the client.
|
|
func Name(s string) func(*Client) {
|
|
return v1.Name(s)
|
|
}
|
|
|
|
// AuthPluginLookup assigns a function to lookup an HTTPAuthPlugin to a new Client.
|
|
// It's intended to be used when creating a Client using New(). Usually this is passed
|
|
// the plugins.AuthPlugin func, which retrieves a registered HTTPAuthPlugin from the
|
|
// plugin manager.
|
|
func AuthPluginLookup(l AuthPluginLookupFunc) func(*Client) {
|
|
return v1.AuthPluginLookup(l)
|
|
}
|
|
|
|
// Logger assigns a logger to the client
|
|
func Logger(l logging.Logger) func(*Client) {
|
|
return v1.Logger(l)
|
|
}
|
|
|
|
// DistributedTracingOpts sets the options to be used by distributed tracing.
|
|
func DistributedTracingOpts(tr tracing.Options) func(*Client) {
|
|
return v1.DistributedTracingOpts(tr)
|
|
}
|
|
|
|
// New returns a new Client for config.
|
|
func New(config []byte, keys map[string]*keys.Config, opts ...func(*Client)) (Client, error) {
|
|
return v1.New(config, keys, opts...)
|
|
}
|