Skip to content

Commit

Permalink
chore(ds-host): update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
teleclimber committed Dec 25, 2023
1 parent b32a8b0 commit ccd90e6
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions cmd/ds-host/domain/domain.go
Expand Up @@ -459,7 +459,7 @@ type AppVersionUI struct {
type AppGetKey string

// ProcessProblem are consts that enable checking for
// a specific problem at processing time.
// a specific type of problem at processing time.
type ProcessProblem string

const ProblemEmpty ProcessProblem = "empty"
Expand All @@ -472,15 +472,14 @@ const ProblemNotFound ProcessProblem = "not-found"
const ProblemError ProcessProblem = "error"

// ProblemPoorExperience indicate the value is usable but does
// not meet best practices
// not meet best practices and affects the user's experience
const ProblemPoorExperience ProcessProblem = "poor-experience"

type ProcessWarning struct {
Field string `json:"field"` // Field indicates area of problem. It can be the json key from manifest or something else
Problem ProcessProblem `json:"problem"` // Problem for classification
BadValue string `json:"bad_value"` // BadValue of field for safe display
Message string `json:"message"` // Message for user or developer
// Add Fatal field to indicate that process failed and this is why?
}

// AppGetMeta has app version data and any errors found in it
Expand Down

0 comments on commit ccd90e6

Please sign in to comment.