Skip to content

Commit be48da5

Browse files
authored
openapi3: fix deprecation comments (#1034)
1 parent 02a0d6f commit be48da5

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

.github/docs/openapi3.txt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,16 @@ func DefineNumberFormatValidator(name string, validator NumberFormatValidator)
128128
number format.
129129

130130
func DefineStringFormat(name string, pattern string)
131-
DefineStringFormat defines a regexp pattern for a given string
132-
format Deprecated: Use openapi3.DefineStringFormatValidator(name,
131+
DefineStringFormat defines a regexp pattern for a given string format
132+
133+
Deprecated: Use openapi3.DefineStringFormatValidator(name,
133134
NewRegexpFormatValidator(pattern)) instead.
134135

135136
func DefineStringFormatCallback(name string, callback func(string) error)
136-
DefineStringFormatCallback defines a callback function for a given
137-
string format Deprecated: Use openapi3.DefineStringFormatValidator(name,
137+
DefineStringFormatCallback defines a callback function for a given string
138+
format
139+
140+
Deprecated: Use openapi3.DefineStringFormatValidator(name,
138141
NewCallbackValidator(fn)) instead.
139142

140143
func DefineStringFormatValidator(name string, validator StringFormatValidator)

openapi3/schema_formats.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,12 +131,14 @@ func DefineIntegerFormatValidator(name string, validator IntegerFormatValidator)
131131
}
132132

133133
// DefineStringFormat defines a regexp pattern for a given string format
134+
//
134135
// Deprecated: Use openapi3.DefineStringFormatValidator(name, NewRegexpFormatValidator(pattern)) instead.
135136
func DefineStringFormat(name string, pattern string) {
136137
DefineStringFormatValidator(name, NewRegexpFormatValidator(pattern))
137138
}
138139

139140
// DefineStringFormatCallback defines a callback function for a given string format
141+
//
140142
// Deprecated: Use openapi3.DefineStringFormatValidator(name, NewCallbackValidator(fn)) instead.
141143
func DefineStringFormatCallback(name string, callback func(string) error) {
142144
DefineStringFormatValidator(name, NewCallbackValidator(callback))

0 commit comments

Comments
 (0)