Serge Bazanski | cc25bdf | 2018-10-25 14:02:58 +0200 | [diff] [blame] | 1 | // Copyright 2015 go-swagger maintainers |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
| 15 | package errors |
| 16 | |
| 17 | import ( |
| 18 | "bytes" |
| 19 | "fmt" |
| 20 | "strings" |
| 21 | ) |
| 22 | |
| 23 | // APIVerificationFailed is an error that contains all the missing info for a mismatched section |
| 24 | // between the api registrations and the api spec |
| 25 | type APIVerificationFailed struct { |
| 26 | Section string |
| 27 | MissingSpecification []string |
| 28 | MissingRegistration []string |
| 29 | } |
| 30 | |
| 31 | // |
| 32 | func (v *APIVerificationFailed) Error() string { |
| 33 | buf := bytes.NewBuffer(nil) |
| 34 | |
| 35 | hasRegMissing := len(v.MissingRegistration) > 0 |
| 36 | hasSpecMissing := len(v.MissingSpecification) > 0 |
| 37 | |
| 38 | if hasRegMissing { |
| 39 | buf.WriteString(fmt.Sprintf("missing [%s] %s registrations", strings.Join(v.MissingRegistration, ", "), v.Section)) |
| 40 | } |
| 41 | |
| 42 | if hasRegMissing && hasSpecMissing { |
| 43 | buf.WriteString("\n") |
| 44 | } |
| 45 | |
| 46 | if hasSpecMissing { |
| 47 | buf.WriteString(fmt.Sprintf("missing from spec file [%s] %s", strings.Join(v.MissingSpecification, ", "), v.Section)) |
| 48 | } |
| 49 | |
| 50 | return buf.String() |
| 51 | } |