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