org

Documentation

Overview

Package org provides the ability for inserting Vela org resources into or extracting Vela org resources from the middleware chain for the API.

Usage:

import "github.com/go-vela/server/router/middleware/org"

Index

• func Establish() gin.HandlerFunc
• func FromContext(c context.Context) string
• func Retrieve(c *gin.Context) string
• func ToContext(c Setter, o string)
• type Setter

Functions

func Establish

func Establish() gin.HandlerFunc

Establish used to check if org param is used only.

func FromContext

func FromContext(c context.Context) string

FromContext returns the Org associated with this context.

func Retrieve

func Retrieve(c *gin.Context) string

Retrieve gets the org in the given context.

func ToContext

func ToContext(c Setter, o string)

ToContext adds the Org to this context if it supports the Setter interface.

Types

type Setter

type Setter interface {
	Set(string, interface{})
}

Setter defines a context that enables setting values.