-
Notifications
You must be signed in to change notification settings - Fork 162
/
problem.go
103 lines (84 loc) · 3.33 KB
/
problem.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
// Copyright © 2019 Banzai Cloud
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package problems
import (
"net/http"
"github.com/moogar0880/problems"
)
const (
// ProblemMediaType is the default media type for a DefaultProblem response
ProblemMediaType = problems.ProblemMediaType
// ProblemMediaTypeXML is the XML variant on the DefaultProblem Media type
ProblemMediaTypeXML = problems.ProblemMediaTypeXML
// DefaultURL is the default url to use for problem types
DefaultURL = problems.DefaultURL
)
// Problem is the interface describing an HTTP API problem. These "problem
// details" are designed to encompass a way to carry machine- readable details
// of errors in a HTTP response to avoid the need to define new error response
// formats for HTTP APIs.
type Problem = problems.Problem
// StatusProblem is the interface describing a problem with an associated
// Status code.
type StatusProblem = problems.StatusProblem
// ValidateProblem ensures that the provided Problem implementation meets the
// Problem description requirements. Which means that the Type is a valid uri,
// and that the Title be a non-empty string. Should the provided Problem be in
// violation of either of these requirements, an error is returned.
func ValidateProblem(p Problem) error {
return problems.ValidateProblem(p)
}
// DefaultProblem describes an RFC-7807 problem.
type DefaultProblem struct {
*problems.DefaultProblem
// Legacy banzai error response fields
Code int `json:"code"`
Message string `json:"message"`
Error string `json:"error"`
}
// NewDetailedProblem returns a problem with details and legacy banzai fields filled.
func NewDetailedProblem(status int, details string) *DefaultProblem {
problem := problems.NewDetailedProblem(status, details)
return &DefaultProblem{
DefaultProblem: problem,
Code: problem.Status,
Message: problem.Detail,
Error: problem.Detail,
}
}
// NewStatusProblem will generate a default problem for the provided HTTP status
// code. The Problem's Status field will be set to match the status argument,
// and the Title will be set to the default Go status text for that code.
func NewStatusProblem(status int) *DefaultProblem {
problem := problems.NewStatusProblem(status)
return &DefaultProblem{
DefaultProblem: problem,
Code: problem.Status,
Message: problem.Title,
Error: problem.Detail,
}
}
// ValidationProblem describes an RFC-7807 problem.
type ValidationProblem struct {
*DefaultProblem
Violations []string `json:"violations"`
}
// NewValidationProblem returns a problem with details and validation errors.
func NewValidationProblem(details string, violations []string) *ValidationProblem {
problem := NewDetailedProblem(http.StatusUnprocessableEntity, details)
return &ValidationProblem{
DefaultProblem: problem,
Violations: violations,
}
}