documents

package
v0.0.0-...-fdfe12d Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 12, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const CreateDocumentBadRequestCode int = 400

CreateDocumentBadRequestCode is the HTTP code returned for type CreateDocumentBadRequest

View Source 
const CreateDocumentCreatedCode int = 201

CreateDocumentCreatedCode is the HTTP code returned for type CreateDocumentCreated

View Source 
const CreateDocumentInternalServerErrorCode int = 500

CreateDocumentInternalServerErrorCode is the HTTP code returned for type CreateDocumentInternalServerError

View Source 
const ShowDocumentBadRequestCode int = 400

ShowDocumentBadRequestCode is the HTTP code returned for type ShowDocumentBadRequest

View Source 
const ShowDocumentForbiddenCode int = 403

ShowDocumentForbiddenCode is the HTTP code returned for type ShowDocumentForbidden

View Source 
const ShowDocumentInternalServerErrorCode int = 500

ShowDocumentInternalServerErrorCode is the HTTP code returned for type ShowDocumentInternalServerError

View Source 
const ShowDocumentNotFoundCode int = 404

ShowDocumentNotFoundCode is the HTTP code returned for type ShowDocumentNotFound

View Source 
const ShowDocumentOKCode int = 200

ShowDocumentOKCode is the HTTP code returned for type ShowDocumentOK

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateDocument 

type CreateDocument struct {
	Context *middleware.Context
	Handler CreateDocumentHandler
}
CreateDocument swagger:route POST /documents documents createDocument

Create a new document

Documents represent a physical artifact such as a scanned document or a PDF file

func NewCreateDocument 

func NewCreateDocument(ctx *middleware.Context, handler CreateDocumentHandler) *CreateDocument

NewCreateDocument creates a new http.Handler for the create document operation

func (*CreateDocument) ServeHTTP 

func (o *CreateDocument) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type CreateDocumentBadRequest 

type CreateDocumentBadRequest struct {
}

CreateDocumentBadRequest invalid request

swagger:response createDocumentBadRequest

func NewCreateDocumentBadRequest 

func NewCreateDocumentBadRequest() *CreateDocumentBadRequest

NewCreateDocumentBadRequest creates CreateDocumentBadRequest with default headers values

func (*CreateDocumentBadRequest) WriteResponse 

func (o *CreateDocumentBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateDocumentCreated 

type CreateDocumentCreated struct {

	/*
	  In: Body
	*/
	Payload *internalmessages.Document `json:"body,omitempty"`
}

CreateDocumentCreated created document

swagger:response createDocumentCreated

func NewCreateDocumentCreated 

func NewCreateDocumentCreated() *CreateDocumentCreated

NewCreateDocumentCreated creates CreateDocumentCreated with default headers values

func (*CreateDocumentCreated) SetPayload 

func (o *CreateDocumentCreated) SetPayload(payload *internalmessages.Document)

SetPayload sets the payload to the create document created response

func (*CreateDocumentCreated) WithPayload 

func (o *CreateDocumentCreated) WithPayload(payload *internalmessages.Document) *CreateDocumentCreated

WithPayload adds the payload to the create document created response

func (*CreateDocumentCreated) WriteResponse 

func (o *CreateDocumentCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateDocumentHandler 

type CreateDocumentHandler interface {
	Handle(CreateDocumentParams) middleware.Responder
}

CreateDocumentHandler interface for that can handle valid create document params

type CreateDocumentHandlerFunc 

type CreateDocumentHandlerFunc func(CreateDocumentParams) middleware.Responder

CreateDocumentHandlerFunc turns a function with the right signature into a create document handler

func (CreateDocumentHandlerFunc) Handle 

func (fn CreateDocumentHandlerFunc) Handle(params CreateDocumentParams) middleware.Responder

Handle executing the request and returning a response

type CreateDocumentInternalServerError 

type CreateDocumentInternalServerError struct {
}

CreateDocumentInternalServerError server error

swagger:response createDocumentInternalServerError

func NewCreateDocumentInternalServerError 

func NewCreateDocumentInternalServerError() *CreateDocumentInternalServerError

NewCreateDocumentInternalServerError creates CreateDocumentInternalServerError with default headers values

func (*CreateDocumentInternalServerError) WriteResponse 

func (o *CreateDocumentInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateDocumentParams 

type CreateDocumentParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  Required: true
	  In: body
	*/
	DocumentPayload *internalmessages.PostDocumentPayload
}

CreateDocumentParams contains all the bound params for the create document operation typically these are obtained from a http.Request

swagger:parameters createDocument

func NewCreateDocumentParams 

func NewCreateDocumentParams() CreateDocumentParams

NewCreateDocumentParams creates a new CreateDocumentParams object

There are no default values defined in the spec.

func (*CreateDocumentParams) BindRequest 

func (o *CreateDocumentParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewCreateDocumentParams() beforehand.

type CreateDocumentURL 

type CreateDocumentURL struct {
	// contains filtered or unexported fields
}

CreateDocumentURL generates an URL for the create document operation

func (*CreateDocumentURL) Build 

func (o *CreateDocumentURL) Build() (*url.URL, error)

Build a url path and query string

func (*CreateDocumentURL) BuildFull 

func (o *CreateDocumentURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*CreateDocumentURL) Must 

func (o *CreateDocumentURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*CreateDocumentURL) SetBasePath 

func (o *CreateDocumentURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*CreateDocumentURL) String 

func (o *CreateDocumentURL) String() string

String returns the string representation of the path with query string

func (*CreateDocumentURL) StringFull 

func (o *CreateDocumentURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*CreateDocumentURL) WithBasePath 

func (o *CreateDocumentURL) WithBasePath(bp string) *CreateDocumentURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type ShowDocument 

type ShowDocument struct {
	Context *middleware.Context
	Handler ShowDocumentHandler
}
ShowDocument swagger:route GET /documents/{documentId} documents showDocument

Returns a document

Returns a document and its uploads

func NewShowDocument 

func NewShowDocument(ctx *middleware.Context, handler ShowDocumentHandler) *ShowDocument

NewShowDocument creates a new http.Handler for the show document operation

func (*ShowDocument) ServeHTTP 

func (o *ShowDocument) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type ShowDocumentBadRequest 

type ShowDocumentBadRequest struct {

	/*
	  In: Body
	*/
	Payload *internalmessages.InvalidRequestResponsePayload `json:"body,omitempty"`
}

ShowDocumentBadRequest invalid request

swagger:response showDocumentBadRequest

func NewShowDocumentBadRequest 

func NewShowDocumentBadRequest() *ShowDocumentBadRequest

NewShowDocumentBadRequest creates ShowDocumentBadRequest with default headers values

func (*ShowDocumentBadRequest) SetPayload 

func (o *ShowDocumentBadRequest) SetPayload(payload *internalmessages.InvalidRequestResponsePayload)

SetPayload sets the payload to the show document bad request response

func (*ShowDocumentBadRequest) WithPayload 

func (o *ShowDocumentBadRequest) WithPayload(payload *internalmessages.InvalidRequestResponsePayload) *ShowDocumentBadRequest

WithPayload adds the payload to the show document bad request response

func (*ShowDocumentBadRequest) WriteResponse 

func (o *ShowDocumentBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ShowDocumentForbidden 

type ShowDocumentForbidden struct {
}

ShowDocumentForbidden not authorized

swagger:response showDocumentForbidden

func NewShowDocumentForbidden 

func NewShowDocumentForbidden() *ShowDocumentForbidden

NewShowDocumentForbidden creates ShowDocumentForbidden with default headers values

func (*ShowDocumentForbidden) WriteResponse 

func (o *ShowDocumentForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ShowDocumentHandler 

type ShowDocumentHandler interface {
	Handle(ShowDocumentParams) middleware.Responder
}

ShowDocumentHandler interface for that can handle valid show document params

type ShowDocumentHandlerFunc 

type ShowDocumentHandlerFunc func(ShowDocumentParams) middleware.Responder

ShowDocumentHandlerFunc turns a function with the right signature into a show document handler

func (ShowDocumentHandlerFunc) Handle 

func (fn ShowDocumentHandlerFunc) Handle(params ShowDocumentParams) middleware.Responder

Handle executing the request and returning a response

type ShowDocumentInternalServerError 

type ShowDocumentInternalServerError struct {
}

ShowDocumentInternalServerError server error

swagger:response showDocumentInternalServerError

func NewShowDocumentInternalServerError 

func NewShowDocumentInternalServerError() *ShowDocumentInternalServerError

NewShowDocumentInternalServerError creates ShowDocumentInternalServerError with default headers values

func (*ShowDocumentInternalServerError) WriteResponse 

func (o *ShowDocumentInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ShowDocumentNotFound 

type ShowDocumentNotFound struct {
}

ShowDocumentNotFound not found

swagger:response showDocumentNotFound

func NewShowDocumentNotFound 

func NewShowDocumentNotFound() *ShowDocumentNotFound

NewShowDocumentNotFound creates ShowDocumentNotFound with default headers values

func (*ShowDocumentNotFound) WriteResponse 

func (o *ShowDocumentNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ShowDocumentOK 

type ShowDocumentOK struct {

	/*
	  In: Body
	*/
	Payload *internalmessages.Document `json:"body,omitempty"`
}

ShowDocumentOK the requested document

swagger:response showDocumentOK

func NewShowDocumentOK 

func NewShowDocumentOK() *ShowDocumentOK

NewShowDocumentOK creates ShowDocumentOK with default headers values

func (*ShowDocumentOK) SetPayload 

func (o *ShowDocumentOK) SetPayload(payload *internalmessages.Document)

SetPayload sets the payload to the show document o k response

func (*ShowDocumentOK) WithPayload 

func (o *ShowDocumentOK) WithPayload(payload *internalmessages.Document) *ShowDocumentOK

WithPayload adds the payload to the show document o k response

func (*ShowDocumentOK) WriteResponse 

func (o *ShowDocumentOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ShowDocumentParams 

type ShowDocumentParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*UUID of the document to return
	  Required: true
	  In: path
	*/
	DocumentID strfmt.UUID
}

ShowDocumentParams contains all the bound params for the show document operation typically these are obtained from a http.Request

swagger:parameters showDocument

func NewShowDocumentParams 

func NewShowDocumentParams() ShowDocumentParams

NewShowDocumentParams creates a new ShowDocumentParams object

There are no default values defined in the spec.

func (*ShowDocumentParams) BindRequest 

func (o *ShowDocumentParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewShowDocumentParams() beforehand.

type ShowDocumentURL 

type ShowDocumentURL struct {
	DocumentID strfmt.UUID
	// contains filtered or unexported fields
}

ShowDocumentURL generates an URL for the show document operation

func (*ShowDocumentURL) Build 

func (o *ShowDocumentURL) Build() (*url.URL, error)

Build a url path and query string

func (*ShowDocumentURL) BuildFull 

func (o *ShowDocumentURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*ShowDocumentURL) Must 

func (o *ShowDocumentURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*ShowDocumentURL) SetBasePath 

func (o *ShowDocumentURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*ShowDocumentURL) String 

func (o *ShowDocumentURL) String() string

String returns the string representation of the path with query string

func (*ShowDocumentURL) StringFull 

func (o *ShowDocumentURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*ShowDocumentURL) WithBasePath 

func (o *ShowDocumentURL) WithBasePath(bp string) *ShowDocumentURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.