Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch document status in v2 API #382

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Patch document status in v2 API #382

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9428830
Validate document status in PATCH request
jfreda Oct 24, 2023
2547609
Patch document status for database
jfreda Oct 24, 2023
56073e1
Clean up wording/styling in some unrelated comments
jfreda Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 34 additions & 8 deletions internal/api/v2/documents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,22 @@ func DocumentHandler(srv server.Server) http.Handler {
}
}

// Validate document Status.
if req.Status != nil {
switch *req.Status {
case "Approved":
case "In-Review":
case "Obsolete":
default:
srv.Logger.Warn("invalid status",
"method", r.Method,
"path", r.URL.Path,
"doc_id", docID)
http.Error(w, "Bad request: invalid status", http.StatusBadRequest)
return
}
}

// Check if document is locked.
locked, err := hcd.IsLocked(docID, srv.DB, srv.GWService, srv.Logger)
if err != nil {
Expand Down Expand Up @@ -461,7 +477,6 @@ func DocumentHandler(srv server.Server) http.Handler {
}
}
// Status.
// TODO: validate status.
if req.Status != nil {
doc.Status = *req.Status
}
Expand All @@ -474,17 +489,17 @@ func DocumentHandler(srv server.Server) http.Handler {
doc.Title = *req.Title
}

// Compare approvers in req and stored object in Algolia
// before we save the patched objected
// Compare approvers in request and stored object in Algolia before we
// save the patched object.
var approversToEmail []string
if len(doc.Approvers) == 0 && req.Approvers != nil &&
len(*req.Approvers) != 0 {
// If there are no approvers of the document
// email the approvers in the request
// If there are no approvers of the document email the approvers in the
// request.
approversToEmail = *req.Approvers
} else if req.Approvers != nil && len(*req.Approvers) != 0 {
// Only compare when there are stored approvers
// and approvers in the request
// Only compare when there are stored approvers and approvers in the
// request.
approversToEmail = compareSlices(doc.Approvers, *req.Approvers)
}

Expand Down Expand Up @@ -699,9 +714,20 @@ Hermes
// Document modified time.
model.DocumentModifiedAt = time.Unix(doc.ModifiedTime, 0)

// Status.
if req.Status != nil {
switch *req.Status {
case "Approved":
model.Status = models.ApprovedDocumentStatus
case "In-Review":
model.Status = models.InReviewDocumentStatus
case "Obsolete":
model.Status = models.ObsoleteDocumentStatus
}
}

// Summary.
if req.Summary != nil {
// model.Summary = *req.Summary
model.Summary = req.Summary
}

Expand Down