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 | /* |
| 16 | Package analysis provides methods to work with a Swagger specification document from |
| 17 | package go-openapi/spec. |
| 18 | |
| 19 | Analyzing a specification |
| 20 | |
| 21 | An analysed specification object (type Spec) provides methods to work with swagger definition. |
| 22 | |
| 23 | Flattening or expanding a specification |
| 24 | |
| 25 | Flattening a specification bundles all remote $ref in the main spec document. |
| 26 | Depending on flattening options, additional preprocessing may take place: |
| 27 | - full flattening: replacing all inline complex constructs by a named entry in #/definitions |
| 28 | - expand: replace all $ref's in the document by their expanded content |
| 29 | |
| 30 | Merging several specifications |
| 31 | |
| 32 | Mixin several specifications merges all Swagger constructs, and warns about found conflicts. |
| 33 | |
| 34 | Fixing a specification |
| 35 | |
| 36 | Unmarshalling a specification with golang json unmarshalling may lead to |
| 37 | some unwanted result on present but empty fields. |
| 38 | |
| 39 | Analyzing a Swagger schema |
| 40 | |
| 41 | Swagger schemas are analyzed to determine their complexity and qualify their content. |
| 42 | */ |
| 43 | package analysis |