Files
threshold/internal/gen/controller/api/services/auth_method_service_grpc.pb.go
T
6b53766aa6 internal/proto: improvements to OpenAPIv2 spec (#4555)
* internal/gen: better API docs

Add various pieces of metadata that can be used by the API docs renderer.
Improve the service labels by specifying explicit tags.
Specify error responses. Specify version at generation time.

* internal/gen: add better errors

The default error entry is now used to cover all errors, as
adding a new error for every possible status code was a bit much.
This also properly includes the real error type now!

* Add various pieces of metadata that can be used by the API docs renderer. Improve the service labels by specifying explicit tags.

* make auth method API docs

* make API docs better

* make auth methods API docs nicer

* internal/gen: better attribute examples

Replace Output Only comments with a field behavior annotation in accounts.
Mark some fields as required.
Add elaborate description for attributes.

* Make API docs better

* Make API docs better

* Make API docs better

* internal/proto: regenerate files

* internal/proto: finish off account service

* Make API docs better

* internal/proto: add better API docs for aliases

* Tidy up service descriptions

* Added description for Boundary controller  API doc

* internal/gen: add better API intro

Copy parts of the API docs into the description

* sdk: add openapi dependency

* internal/gen: move global API doc to separate file

* internal/gen: remove required annotations

Unfortunately, while these help with the creating of resources, they still
appear required in contexts where they are not, such as when
updating a resource.

* Review comments

---------

Co-authored-by: jigar-hashicorp <jigar.shah@hashicorp.com>
Co-authored-by: Isaac Christian (he/him) <112639904+isaacchristian@users.noreply.github.com>
2024-04-08 13:55:17 -07:00

381 lines
17 KiB
Go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
// Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.3.0
// - protoc (unknown)
// source: controller/api/services/v1/auth_method_service.proto
package services
import (
context "context"
grpc "google.golang.org/grpc"
codes "google.golang.org/grpc/codes"
status "google.golang.org/grpc/status"
)
// This is a compile-time assertion to ensure that this generated file
// is compatible with the grpc package it is being compiled against.
// Requires gRPC-Go v1.32.0 or later.
const _ = grpc.SupportPackageIsVersion7
const (
AuthMethodService_GetAuthMethod_FullMethodName = "/controller.api.services.v1.AuthMethodService/GetAuthMethod"
AuthMethodService_ListAuthMethods_FullMethodName = "/controller.api.services.v1.AuthMethodService/ListAuthMethods"
AuthMethodService_CreateAuthMethod_FullMethodName = "/controller.api.services.v1.AuthMethodService/CreateAuthMethod"
AuthMethodService_UpdateAuthMethod_FullMethodName = "/controller.api.services.v1.AuthMethodService/UpdateAuthMethod"
AuthMethodService_DeleteAuthMethod_FullMethodName = "/controller.api.services.v1.AuthMethodService/DeleteAuthMethod"
AuthMethodService_ChangeState_FullMethodName = "/controller.api.services.v1.AuthMethodService/ChangeState"
AuthMethodService_Authenticate_FullMethodName = "/controller.api.services.v1.AuthMethodService/Authenticate"
)
// AuthMethodServiceClient is the client API for AuthMethodService service.
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type AuthMethodServiceClient interface {
// GetAuthMethod returns a stored auth method if present. The provided request
// must include the auth method id. If missing, malformed or referencing a
// non existing resource an error is returned.
GetAuthMethod(ctx context.Context, in *GetAuthMethodRequest, opts ...grpc.CallOption) (*GetAuthMethodResponse, error)
// ListAuthMethods returns a list of stored auth methods which are in the
// provided scope. The request must include the scope id and if missing,
// malformed, or referencing a non existing scope, an error is returned.
ListAuthMethods(ctx context.Context, in *ListAuthMethodsRequest, opts ...grpc.CallOption) (*ListAuthMethodsResponse, error)
// CreateAuthMethod creates and stores an auth method in Boundary. The
// provided request must include the scope in which the auth method will be
// created. If the scope id is missing, malformed or referencing a
// non existing resource an error is returned. If a name is provided that is
// in use in another auth method in the same scope, an error is returned.
CreateAuthMethod(ctx context.Context, in *CreateAuthMethodRequest, opts ...grpc.CallOption) (*CreateAuthMethodResponse, error)
// UpdateAuthMethod updates an existing auth method in Boundary. The provided
// auth method must not have any read only fields set. The update mask must be
// included in the request and contain at least 1 mutable field. To unset
// a field's value, include the field in the update mask and don't set it
// in the provided user. An error is returned if the auth method id is missing
// or reference a non existing resource. An error is also returned if the
// request attempts to update the name to one that is already in use by
// another auth method in the parent scope.
UpdateAuthMethod(ctx context.Context, in *UpdateAuthMethodRequest, opts ...grpc.CallOption) (*UpdateAuthMethodResponse, error)
// DeleteAuthMethod removes an auth method from Boundary. If the auth method id
// is malformed or not provided an error is returned.
DeleteAuthMethod(ctx context.Context, in *DeleteAuthMethodRequest, opts ...grpc.CallOption) (*DeleteAuthMethodResponse, error)
// ChangeState changes the state of an auth method from Boundary.
ChangeState(ctx context.Context, in *ChangeStateRequest, opts ...grpc.CallOption) (*ChangeStateResponse, error)
// Authenticate validates credentials provided and returns an Auth Token.
Authenticate(ctx context.Context, in *AuthenticateRequest, opts ...grpc.CallOption) (*AuthenticateResponse, error)
}
type authMethodServiceClient struct {
cc grpc.ClientConnInterface
}
func NewAuthMethodServiceClient(cc grpc.ClientConnInterface) AuthMethodServiceClient {
return &authMethodServiceClient{cc}
}
func (c *authMethodServiceClient) GetAuthMethod(ctx context.Context, in *GetAuthMethodRequest, opts ...grpc.CallOption) (*GetAuthMethodResponse, error) {
out := new(GetAuthMethodResponse)
err := c.cc.Invoke(ctx, AuthMethodService_GetAuthMethod_FullMethodName, in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *authMethodServiceClient) ListAuthMethods(ctx context.Context, in *ListAuthMethodsRequest, opts ...grpc.CallOption) (*ListAuthMethodsResponse, error) {
out := new(ListAuthMethodsResponse)
err := c.cc.Invoke(ctx, AuthMethodService_ListAuthMethods_FullMethodName, in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *authMethodServiceClient) CreateAuthMethod(ctx context.Context, in *CreateAuthMethodRequest, opts ...grpc.CallOption) (*CreateAuthMethodResponse, error) {
out := new(CreateAuthMethodResponse)
err := c.cc.Invoke(ctx, AuthMethodService_CreateAuthMethod_FullMethodName, in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *authMethodServiceClient) UpdateAuthMethod(ctx context.Context, in *UpdateAuthMethodRequest, opts ...grpc.CallOption) (*UpdateAuthMethodResponse, error) {
out := new(UpdateAuthMethodResponse)
err := c.cc.Invoke(ctx, AuthMethodService_UpdateAuthMethod_FullMethodName, in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *authMethodServiceClient) DeleteAuthMethod(ctx context.Context, in *DeleteAuthMethodRequest, opts ...grpc.CallOption) (*DeleteAuthMethodResponse, error) {
out := new(DeleteAuthMethodResponse)
err := c.cc.Invoke(ctx, AuthMethodService_DeleteAuthMethod_FullMethodName, in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *authMethodServiceClient) ChangeState(ctx context.Context, in *ChangeStateRequest, opts ...grpc.CallOption) (*ChangeStateResponse, error) {
out := new(ChangeStateResponse)
err := c.cc.Invoke(ctx, AuthMethodService_ChangeState_FullMethodName, in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *authMethodServiceClient) Authenticate(ctx context.Context, in *AuthenticateRequest, opts ...grpc.CallOption) (*AuthenticateResponse, error) {
out := new(AuthenticateResponse)
err := c.cc.Invoke(ctx, AuthMethodService_Authenticate_FullMethodName, in, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
// AuthMethodServiceServer is the server API for AuthMethodService service.
// All implementations must embed UnimplementedAuthMethodServiceServer
// for forward compatibility
type AuthMethodServiceServer interface {
// GetAuthMethod returns a stored auth method if present. The provided request
// must include the auth method id. If missing, malformed or referencing a
// non existing resource an error is returned.
GetAuthMethod(context.Context, *GetAuthMethodRequest) (*GetAuthMethodResponse, error)
// ListAuthMethods returns a list of stored auth methods which are in the
// provided scope. The request must include the scope id and if missing,
// malformed, or referencing a non existing scope, an error is returned.
ListAuthMethods(context.Context, *ListAuthMethodsRequest) (*ListAuthMethodsResponse, error)
// CreateAuthMethod creates and stores an auth method in Boundary. The
// provided request must include the scope in which the auth method will be
// created. If the scope id is missing, malformed or referencing a
// non existing resource an error is returned. If a name is provided that is
// in use in another auth method in the same scope, an error is returned.
CreateAuthMethod(context.Context, *CreateAuthMethodRequest) (*CreateAuthMethodResponse, error)
// UpdateAuthMethod updates an existing auth method in Boundary. The provided
// auth method must not have any read only fields set. The update mask must be
// included in the request and contain at least 1 mutable field. To unset
// a field's value, include the field in the update mask and don't set it
// in the provided user. An error is returned if the auth method id is missing
// or reference a non existing resource. An error is also returned if the
// request attempts to update the name to one that is already in use by
// another auth method in the parent scope.
UpdateAuthMethod(context.Context, *UpdateAuthMethodRequest) (*UpdateAuthMethodResponse, error)
// DeleteAuthMethod removes an auth method from Boundary. If the auth method id
// is malformed or not provided an error is returned.
DeleteAuthMethod(context.Context, *DeleteAuthMethodRequest) (*DeleteAuthMethodResponse, error)
// ChangeState changes the state of an auth method from Boundary.
ChangeState(context.Context, *ChangeStateRequest) (*ChangeStateResponse, error)
// Authenticate validates credentials provided and returns an Auth Token.
Authenticate(context.Context, *AuthenticateRequest) (*AuthenticateResponse, error)
mustEmbedUnimplementedAuthMethodServiceServer()
}
// UnimplementedAuthMethodServiceServer must be embedded to have forward compatible implementations.
type UnimplementedAuthMethodServiceServer struct {
}
func (UnimplementedAuthMethodServiceServer) GetAuthMethod(context.Context, *GetAuthMethodRequest) (*GetAuthMethodResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method GetAuthMethod not implemented")
}
func (UnimplementedAuthMethodServiceServer) ListAuthMethods(context.Context, *ListAuthMethodsRequest) (*ListAuthMethodsResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method ListAuthMethods not implemented")
}
func (UnimplementedAuthMethodServiceServer) CreateAuthMethod(context.Context, *CreateAuthMethodRequest) (*CreateAuthMethodResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method CreateAuthMethod not implemented")
}
func (UnimplementedAuthMethodServiceServer) UpdateAuthMethod(context.Context, *UpdateAuthMethodRequest) (*UpdateAuthMethodResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method UpdateAuthMethod not implemented")
}
func (UnimplementedAuthMethodServiceServer) DeleteAuthMethod(context.Context, *DeleteAuthMethodRequest) (*DeleteAuthMethodResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method DeleteAuthMethod not implemented")
}
func (UnimplementedAuthMethodServiceServer) ChangeState(context.Context, *ChangeStateRequest) (*ChangeStateResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method ChangeState not implemented")
}
func (UnimplementedAuthMethodServiceServer) Authenticate(context.Context, *AuthenticateRequest) (*AuthenticateResponse, error) {
return nil, status.Errorf(codes.Unimplemented, "method Authenticate not implemented")
}
func (UnimplementedAuthMethodServiceServer) mustEmbedUnimplementedAuthMethodServiceServer() {}
// UnsafeAuthMethodServiceServer may be embedded to opt out of forward compatibility for this service.
// Use of this interface is not recommended, as added methods to AuthMethodServiceServer will
// result in compilation errors.
type UnsafeAuthMethodServiceServer interface {
mustEmbedUnimplementedAuthMethodServiceServer()
}
func RegisterAuthMethodServiceServer(s grpc.ServiceRegistrar, srv AuthMethodServiceServer) {
s.RegisterService(&AuthMethodService_ServiceDesc, srv)
}
func _AuthMethodService_GetAuthMethod_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(GetAuthMethodRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AuthMethodServiceServer).GetAuthMethod(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: AuthMethodService_GetAuthMethod_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AuthMethodServiceServer).GetAuthMethod(ctx, req.(*GetAuthMethodRequest))
}
return interceptor(ctx, in, info, handler)
}
func _AuthMethodService_ListAuthMethods_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(ListAuthMethodsRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AuthMethodServiceServer).ListAuthMethods(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: AuthMethodService_ListAuthMethods_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AuthMethodServiceServer).ListAuthMethods(ctx, req.(*ListAuthMethodsRequest))
}
return interceptor(ctx, in, info, handler)
}
func _AuthMethodService_CreateAuthMethod_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(CreateAuthMethodRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AuthMethodServiceServer).CreateAuthMethod(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: AuthMethodService_CreateAuthMethod_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AuthMethodServiceServer).CreateAuthMethod(ctx, req.(*CreateAuthMethodRequest))
}
return interceptor(ctx, in, info, handler)
}
func _AuthMethodService_UpdateAuthMethod_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(UpdateAuthMethodRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AuthMethodServiceServer).UpdateAuthMethod(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: AuthMethodService_UpdateAuthMethod_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AuthMethodServiceServer).UpdateAuthMethod(ctx, req.(*UpdateAuthMethodRequest))
}
return interceptor(ctx, in, info, handler)
}
func _AuthMethodService_DeleteAuthMethod_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(DeleteAuthMethodRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AuthMethodServiceServer).DeleteAuthMethod(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: AuthMethodService_DeleteAuthMethod_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AuthMethodServiceServer).DeleteAuthMethod(ctx, req.(*DeleteAuthMethodRequest))
}
return interceptor(ctx, in, info, handler)
}
func _AuthMethodService_ChangeState_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(ChangeStateRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AuthMethodServiceServer).ChangeState(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: AuthMethodService_ChangeState_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AuthMethodServiceServer).ChangeState(ctx, req.(*ChangeStateRequest))
}
return interceptor(ctx, in, info, handler)
}
func _AuthMethodService_Authenticate_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(AuthenticateRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(AuthMethodServiceServer).Authenticate(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: AuthMethodService_Authenticate_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(AuthMethodServiceServer).Authenticate(ctx, req.(*AuthenticateRequest))
}
return interceptor(ctx, in, info, handler)
}
// AuthMethodService_ServiceDesc is the grpc.ServiceDesc for AuthMethodService service.
// It's only intended for direct use with grpc.RegisterService,
// and not to be introspected or modified (even as a copy)
var AuthMethodService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "controller.api.services.v1.AuthMethodService",
HandlerType: (*AuthMethodServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetAuthMethod",
Handler: _AuthMethodService_GetAuthMethod_Handler,
},
{
MethodName: "ListAuthMethods",
Handler: _AuthMethodService_ListAuthMethods_Handler,
},
{
MethodName: "CreateAuthMethod",
Handler: _AuthMethodService_CreateAuthMethod_Handler,
},
{
MethodName: "UpdateAuthMethod",
Handler: _AuthMethodService_UpdateAuthMethod_Handler,
},
{
MethodName: "DeleteAuthMethod",
Handler: _AuthMethodService_DeleteAuthMethod_Handler,
},
{
MethodName: "ChangeState",
Handler: _AuthMethodService_ChangeState_Handler,
},
{
MethodName: "Authenticate",
Handler: _AuthMethodService_Authenticate_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "controller/api/services/v1/auth_method_service.proto",
}