package
2.85.0+incompatible
Repository: https://github.com/transcom/mymove.git
Documentation: pkg.go.dev
# Functions
NewCreateDocument creates a new http.Handler for the create document operation.
NewCreateDocumentBadRequest creates CreateDocumentBadRequest with default headers values.
NewCreateDocumentCreated creates CreateDocumentCreated with default headers values.
NewCreateDocumentInternalServerError creates CreateDocumentInternalServerError with default headers values.
NewCreateDocumentParams creates a new CreateDocumentParams object
There are no default values defined in the spec.
NewShowDocument creates a new http.Handler for the show document operation.
NewShowDocumentBadRequest creates ShowDocumentBadRequest with default headers values.
NewShowDocumentForbidden creates ShowDocumentForbidden with default headers values.
NewShowDocumentInternalServerError creates ShowDocumentInternalServerError with default headers values.
NewShowDocumentNotFound creates ShowDocumentNotFound with default headers values.
NewShowDocumentOK creates ShowDocumentOK with default headers values.
NewShowDocumentParams creates a new ShowDocumentParams object
There are no default values defined in the spec.
# Constants
CreateDocumentBadRequestCode is the HTTP code returned for type CreateDocumentBadRequest.
CreateDocumentCreatedCode is the HTTP code returned for type CreateDocumentCreated.
CreateDocumentInternalServerErrorCode is the HTTP code returned for type CreateDocumentInternalServerError.
ShowDocumentBadRequestCode is the HTTP code returned for type ShowDocumentBadRequest.
ShowDocumentForbiddenCode is the HTTP code returned for type ShowDocumentForbidden.
ShowDocumentInternalServerErrorCode is the HTTP code returned for type ShowDocumentInternalServerError.
ShowDocumentNotFoundCode is the HTTP code returned for type ShowDocumentNotFound.
ShowDocumentOKCode is the HTTP code returned for type ShowDocumentOK.
# Structs
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
*/.
CreateDocumentBadRequest invalid request
swagger:response createDocumentBadRequest
*/.
CreateDocumentCreated created document
swagger:response createDocumentCreated
*/.
CreateDocumentInternalServerError server error
swagger:response createDocumentInternalServerError
*/.
CreateDocumentParams contains all the bound params for the create document operation typically these are obtained from a http.Request
swagger:parameters createDocument.
CreateDocumentURL generates an URL for the create document operation.
ShowDocument swagger:route GET /documents/{documentId} documents showDocument
# Returns a document
Returns a document and its uploads
*/.
ShowDocumentBadRequest invalid request
swagger:response showDocumentBadRequest
*/.
ShowDocumentForbidden not authorized
swagger:response showDocumentForbidden
*/.
ShowDocumentInternalServerError server error
swagger:response showDocumentInternalServerError
*/.
ShowDocumentNotFound not found
swagger:response showDocumentNotFound
*/.
ShowDocumentOK the requested document
swagger:response showDocumentOK
*/.
ShowDocumentParams contains all the bound params for the show document operation typically these are obtained from a http.Request
swagger:parameters showDocument.
ShowDocumentURL generates an URL for the show document operation.
# Interfaces
CreateDocumentHandler interface for that can handle valid create document params.
ShowDocumentHandler interface for that can handle valid show document params.
# Type aliases
CreateDocumentHandlerFunc turns a function with the right signature into a create document handler.
ShowDocumentHandlerFunc turns a function with the right signature into a show document handler.