adminusers

Documentation

Overview

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

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

Index

• Constants
• func GetSwagger() (swagger *openapi3.T, err error)
• func Handler(si ServerInterface) http.Handler
• func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
• func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
• func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• type ChiServerOptions
• type CreateVironAdminUserJSONBody
• type CreateVironAdminUserJSONRequestBody
• type ListVironAdminUsersParams
• type MiddlewareFunc
• type ServerInterface
  • func New() ServerInterface
• type ServerInterfaceWrapper
  • func (siw *ServerInterfaceWrapper) CreateVironAdminUser(w http.ResponseWriter, r *http.Request)
  • func (siw *ServerInterfaceWrapper) ListVironAdminUsers(w http.ResponseWriter, r *http.Request)
  • func (siw *ServerInterfaceWrapper) RemoveVironAdminUser(w http.ResponseWriter, r *http.Request)
  • func (siw *ServerInterfaceWrapper) UpdateVironAdminUser(w http.ResponseWriter, r *http.Request)
• type UpdateVironAdminUserJSONBody
• type UpdateVironAdminUserJSONRequestBody
• type VironAdminUser
• type VironAdminUserCreatePayload
• type VironAdminUserList
• type VironAdminUserListWithPager
  • func PagerToVironAdminUserListWithPager(currentPage, maxPage int, users []*domains.AdminUser) VironAdminUserListWithPager
• type VironAdminUserUpdatePayload

Constants

const (
	JwtScopes = "jwt.Scopes"
)

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type ChiServerOptions

type ChiServerOptions struct {
	BaseURL     string
	BaseRouter  chi.Router
	Middlewares []MiddlewareFunc
}

type CreateVironAdminUserJSONBody

type CreateVironAdminUserJSONBody VironAdminUserCreatePayload

CreateVironAdminUserJSONBody defines parameters for CreateVironAdminUser.

type CreateVironAdminUserJSONRequestBody

type CreateVironAdminUserJSONRequestBody CreateVironAdminUserJSONBody

CreateVironAdminUserJSONRequestBody defines body for CreateVironAdminUser for application/json ContentType.

type ListVironAdminUsersParams

type ListVironAdminUsersParams struct {
	Id     *externalRef0.VironIdQueryParam     `json:"id,omitempty"`
	Email  *externalRef0.VironEmailQueryParam  `json:"email,omitempty"`
	RoleId *externalRef0.VironRoleIdQueryParam `json:"roleId,omitempty"`

	// Size of list
	Size *externalRef0.VironPagerSizeQueryParam `json:"size,omitempty"`

	// Page number of list
	Page *externalRef0.VironPagerPageQueryParam `json:"page,omitempty"`

	// Sort specification of list
	Sort *externalRef0.VironSortQueryParam `json:"sort,omitempty"`
}

ListVironAdminUsersParams defines parameters for ListVironAdminUsers.

type MiddlewareFunc

type MiddlewareFunc func(http.HandlerFunc) http.HandlerFunc

type ServerInterface

type ServerInterface interface {
	// list admin users
	// (GET /viron/adminusers)
	ListVironAdminUsers(w http.ResponseWriter, r *http.Request, params ListVironAdminUsersParams)
	// create an admin user
	// (POST /viron/adminusers)
	CreateVironAdminUser(w http.ResponseWriter, r *http.Request)
	// remove an admin user
	// (DELETE /viron/adminusers/{id})
	RemoveVironAdminUser(w http.ResponseWriter, r *http.Request, id externalRef0.VironIdPathParam)
	// update an admin user
	// (PUT /viron/adminusers/{id})
	UpdateVironAdminUser(w http.ResponseWriter, r *http.Request, id externalRef0.VironIdPathParam)
}

ServerInterface represents all server handlers.

func New

func New() ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) CreateVironAdminUser

func (siw *ServerInterfaceWrapper) CreateVironAdminUser(w http.ResponseWriter, r *http.Request)

CreateVironAdminUser operation middleware

func (*ServerInterfaceWrapper) ListVironAdminUsers

func (siw *ServerInterfaceWrapper) ListVironAdminUsers(w http.ResponseWriter, r *http.Request)

ListVironAdminUsers operation middleware

func (*ServerInterfaceWrapper) RemoveVironAdminUser

func (siw *ServerInterfaceWrapper) RemoveVironAdminUser(w http.ResponseWriter, r *http.Request)

RemoveVironAdminUser operation middleware

func (*ServerInterfaceWrapper) UpdateVironAdminUser

func (siw *ServerInterfaceWrapper) UpdateVironAdminUser(w http.ResponseWriter, r *http.Request)

UpdateVironAdminUser operation middleware

type UpdateVironAdminUserJSONBody

type UpdateVironAdminUserJSONBody VironAdminUserUpdatePayload

UpdateVironAdminUserJSONBody defines parameters for UpdateVironAdminUser.

type UpdateVironAdminUserJSONRequestBody

type UpdateVironAdminUserJSONRequestBody UpdateVironAdminUserJSONBody

UpdateVironAdminUserJSONRequestBody defines body for UpdateVironAdminUser for application/json ContentType.

type VironAdminUser

type VironAdminUser struct {
	// 認証タイプ
	AuthType string `json:"authType"`

	// 作成日時
	CreatedAt *externalRef0.VironCreatedAt `json:"createdAt,omitempty"`

	// Eメールアドレス
	Email openapi_types.Email `json:"email"`

	// 管理ユーザーID
	Id string `json:"id"`

	// ロール一覧
	RoleIds *[]string `json:"roleIds,omitempty"`

	// 更新日時
	UpdatedAt *externalRef0.VironUpdatedAt `json:"updatedAt,omitempty"`
}

VironAdminUser defines model for VironAdminUser.

type VironAdminUserCreatePayload

type VironAdminUserCreatePayload struct {
	// Eメールアドレス
	Email openapi_types.Email `json:"email"`

	// パスワード
	Password string `json:"password"`

	// ロールID
	RoleIds *[]string `json:"roleIds,omitempty"`
}

VironAdminUserCreatePayload defines model for VironAdminUserCreatePayload.

type VironAdminUserList

type VironAdminUserList []VironAdminUser

VironAdminUserList defines model for VironAdminUserList.

type VironAdminUserListWithPager

type VironAdminUserListWithPager struct {
	// Embedded struct due to allOf(./components.yaml#/components/schemas/VironPager)
	externalRef0.VironPager `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	List VironAdminUserList `json:"list"`
}

VironAdminUserListWithPager defines model for VironAdminUserListWithPager.

func PagerToVironAdminUserListWithPager

func PagerToVironAdminUserListWithPager(currentPage, maxPage int, users []*domains.AdminUser) VironAdminUserListWithPager

type VironAdminUserUpdatePayload

type VironAdminUserUpdatePayload struct {
	// パスワード
	Password *string `json:"password,omitempty"`

	// ロールID
	RoleIds *[]string `json:"roleIds,omitempty"`
}

VironAdminUserUpdatePayload defines model for VironAdminUserUpdatePayload.