server

Documentation

Overview

Package server provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.13.0 DO NOT EDIT.

Index

• func RegisterHandlers(router EchoRouter, si ServerInterface)
• func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
• type EchoRouter
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) CreatePermissionSet(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) CreatePermissionSetAssignments(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) DeletePermissionSet(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) DeletePermissionSetAssignment(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) GetAPIDocument(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) GetPermissionSet(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) ListAWSManagedPolicies(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) ListMyRoles(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) ListPermissionSetAssignments(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) ListPermissionSets(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) ListRoles(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) RedeployPermissionSetAssignment(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) UpdatePermissionSet(ctx echo.Context) error

Functions

func RegisterHandlers

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

type EchoRouter

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type ServerInterface

type ServerInterface interface {
	// List permission sets for an organisation
	// (GET /permission-sets)
	ListPermissionSets(ctx echo.Context, params ListPermissionSetsParams) error
	// Create permission set
	// (POST /permission-sets)
	CreatePermissionSet(ctx echo.Context) error
	// List AWS managed policies
	// (GET /permission-sets/aws-managed-policies)
	ListAWSManagedPolicies(ctx echo.Context) error
	// List roles
	// (GET /permission-sets/roles)
	ListRoles(ctx echo.Context, params ListRolesParams) error
	// List my roles
	// (GET /permission-sets/roles/me)
	ListMyRoles(ctx echo.Context, params ListMyRolesParams) error
	// Delete permission set
	// (DELETE /permission-sets/{permission_set_id})
	DeletePermissionSet(ctx echo.Context, permissionSetId PermissionSetID) error
	// Get permission set
	// (GET /permission-sets/{permission_set_id})
	GetPermissionSet(ctx echo.Context, permissionSetId PermissionSetID) error
	// Update permission set
	// (PUT /permission-sets/{permission_set_id})
	UpdatePermissionSet(ctx echo.Context, permissionSetId PermissionSetID) error
	// Get assignments
	// (GET /permission-sets/{permission_set_id}/assignments)
	ListPermissionSetAssignments(ctx echo.Context, permissionSetId PermissionSetID, params ListPermissionSetAssignmentsParams) error
	// Create assignments
	// (POST /permission-sets/{permission_set_id}/assignments)
	CreatePermissionSetAssignments(ctx echo.Context, permissionSetId PermissionSetID) error
	// Delete assignment
	// (DELETE /permission-sets/{permission_set_id}/assignments/{assignment_id})
	DeletePermissionSetAssignment(ctx echo.Context, permissionSetId PermissionSetID, assignmentId AssignmentID) error
	// Redeploy assignment
	// (PUT /permission-sets/{permission_set_id}/assignments/{assignment_id})
	RedeployPermissionSetAssignment(ctx echo.Context, permissionSetId PermissionSetID, assignmentId AssignmentID) error
	// Get the OpenAPI specification document for this API.
	// (GET /public/api-document)
	GetAPIDocument(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) CreatePermissionSet

func (w *ServerInterfaceWrapper) CreatePermissionSet(ctx echo.Context) error

CreatePermissionSet converts echo context to params.

func (*ServerInterfaceWrapper) CreatePermissionSetAssignments

func (w *ServerInterfaceWrapper) CreatePermissionSetAssignments(ctx echo.Context) error

CreatePermissionSetAssignments converts echo context to params.

func (*ServerInterfaceWrapper) DeletePermissionSet

func (w *ServerInterfaceWrapper) DeletePermissionSet(ctx echo.Context) error

DeletePermissionSet converts echo context to params.

func (*ServerInterfaceWrapper) DeletePermissionSetAssignment

func (w *ServerInterfaceWrapper) DeletePermissionSetAssignment(ctx echo.Context) error

DeletePermissionSetAssignment converts echo context to params.

func (*ServerInterfaceWrapper) GetAPIDocument

func (w *ServerInterfaceWrapper) GetAPIDocument(ctx echo.Context) error

GetAPIDocument converts echo context to params.

func (*ServerInterfaceWrapper) GetPermissionSet

func (w *ServerInterfaceWrapper) GetPermissionSet(ctx echo.Context) error

GetPermissionSet converts echo context to params.

func (*ServerInterfaceWrapper) ListAWSManagedPolicies

func (w *ServerInterfaceWrapper) ListAWSManagedPolicies(ctx echo.Context) error

ListAWSManagedPolicies converts echo context to params.

func (*ServerInterfaceWrapper) ListMyRoles

func (w *ServerInterfaceWrapper) ListMyRoles(ctx echo.Context) error

ListMyRoles converts echo context to params.

func (*ServerInterfaceWrapper) ListPermissionSetAssignments

func (w *ServerInterfaceWrapper) ListPermissionSetAssignments(ctx echo.Context) error

ListPermissionSetAssignments converts echo context to params.

func (*ServerInterfaceWrapper) ListPermissionSets

func (w *ServerInterfaceWrapper) ListPermissionSets(ctx echo.Context) error

ListPermissionSets converts echo context to params.

func (*ServerInterfaceWrapper) ListRoles

func (w *ServerInterfaceWrapper) ListRoles(ctx echo.Context) error

ListRoles converts echo context to params.

func (*ServerInterfaceWrapper) RedeployPermissionSetAssignment

func (w *ServerInterfaceWrapper) RedeployPermissionSetAssignment(ctx echo.Context) error

RedeployPermissionSetAssignment converts echo context to params.

func (*ServerInterfaceWrapper) UpdatePermissionSet

func (w *ServerInterfaceWrapper) UpdatePermissionSet(ctx echo.Context) error

UpdatePermissionSet converts echo context to params.