operation

Documentation

Index

• Constants
• type CreateAuthorizationsBody
• type Operation
  • func New(v vault.Vault) *Operation
  • func (o *Operation) CreateAuthorization(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) CreateVault(rw http.ResponseWriter, _ *http.Request)
  • func (o *Operation) DeleteAuthorization(rw http.ResponseWriter, _ *http.Request)
  • func (o *Operation) DeleteVault(rw http.ResponseWriter, _ *http.Request)
  • func (o *Operation) GetAuthorization(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) GetDocMetadata(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) GetRESTHandlers() []handler.Handler
  • func (o *Operation) SaveDoc(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) WriteResponse(rw http.ResponseWriter, v interface{}, status int)
• type SaveDocRequestBody

Constants

const (
	CreateVaultPath         = operationID
	DeleteVaultPath         = operationID + "/{vaultID}"
	SaveDocPath             = operationID + "/{vaultID}/docs"
	GetDocMetadataPath      = operationID + "/{vaultID}/docs/{docID}/metadata"
	CreateAuthorizationPath = operationID + "/{vaultID}/authorizations"
	GetAuthorizationPath    = operationID + "/{vaultID}/authorizations/{authID}"
	DeleteAuthorizationPath = operationID + "/{vaultID}/authorizations/{authID}"
)

API endpoints.

Types

type CreateAuthorizationsBody

type CreateAuthorizationsBody struct {
	Scope           vault.AuthorizationsScope `json:"scope"`
	RequestingParty string                    `json:"requestingParty"`
}

CreateAuthorizationsBody describes body for the createAuthorizations request.

type Operation

type Operation struct {
	GenerateID func() (string, error)
	// contains filtered or unexported fields
}

Operation defines handlers for vault service.

func New

func New(v vault.Vault) *Operation

New returns operation instance.

func (*Operation) CreateAuthorization

func (o *Operation) CreateAuthorization(rw http.ResponseWriter, req *http.Request)

CreateAuthorization swagger:route POST /vaults/{vaultID}/authorizations vault createAuthorizationsReq

Creates an authorization.

Responses:

default: genericError
    201: createAuthorizationResp

func (*Operation) CreateVault

func (o *Operation) CreateVault(rw http.ResponseWriter, _ *http.Request)

CreateVault swagger:route POST /vaults vault createVaultReq

Creates a new vault.

Responses:

default: genericError
    201: createVaultResp

func (*Operation) DeleteAuthorization

func (o *Operation) DeleteAuthorization(rw http.ResponseWriter, _ *http.Request)

DeleteAuthorization swagger:route DELETE /vaults/{vaultID}/authorizations/{authID} vault deleteAuthorizationReq

Deletes an authorization.

Responses:

default: genericError
    200: deleteAuthorizationResp

func (*Operation) DeleteVault

func (o *Operation) DeleteVault(rw http.ResponseWriter, _ *http.Request)

DeleteVault swagger:route DELETE /vaults/{vaultID} vault deleteVaultReq

Deletes an existing vault.

Responses:

default: genericError
    200: deleteVaultResp

func (*Operation) GetAuthorization

func (o *Operation) GetAuthorization(rw http.ResponseWriter, req *http.Request)

GetAuthorization swagger:route GET /vaults/{vaultID}/authorizations/{authID} vault getAuthorizationReq

Fetches an authorization.

Responses:

default: genericError
    200: getAuthorizationResp

func (*Operation) GetDocMetadata

func (o *Operation) GetDocMetadata(rw http.ResponseWriter, req *http.Request)

GetDocMetadata swagger:route GET /vaults/{vaultID}/docs/{docID}/metadata vault getDocMetadataReq

Returns the document`s metadata by given docID.

Responses:

default: genericError
    200: getDocMetadataResp

func (*Operation) GetRESTHandlers

func (o *Operation) GetRESTHandlers() []handler.Handler

GetRESTHandlers get all controller API handler available for this service.

func (*Operation) SaveDoc

func (o *Operation) SaveDoc(rw http.ResponseWriter, req *http.Request)

SaveDoc swagger:route POST /vaults/{vaultID}/docs vault saveDocReq

Creates or updates a document by encrypting it and storing it in the vault.

Responses:

default: genericError
    201: saveDocResp

func (*Operation) WriteResponse

func (o *Operation) WriteResponse(rw http.ResponseWriter, v interface{}, status int)

WriteResponse writes response.

type SaveDocRequestBody

type SaveDocRequestBody struct {
	ID      string          `json:"id"`
	Content json.RawMessage `json:"content"`
	Tags    []string        `json:"tags"`
}

SaveDocRequestBody describes body for the SaveDoc request.