Adding more docs to v2 swagger model.

once and done job, not much fun to be honest ;)

datamodel/high/v2/parameter_definitions.go

@@ -5,11 +5,19 @@ package v2
 
 import low "github.com/pb33f/libopenapi/datamodel/low/v2"
 
+// ParameterDefinitions is a high-level representation of a Swagger / OpenAPI 2 Parameters Definitions object
+// that is backed by a low-level one.
+//
+// ParameterDefinitions holds parameters to be reused across operations. Parameter definitions can be
+// referenced to the ones defined here. It does not define global operation parameters
+//  - https://swagger.io/specification/v2/#parametersDefinitionsObject
 type ParameterDefinitions struct {
 	Definitions map[string]*Parameter
 	low         *low.ParameterDefinitions
 }
 
+// NewParametersDefinitions creates a new instance of a high-level ParameterDefinitions, from a low-level one.
+// Every parameter is extracted asynchronously due to the potential depth
 func NewParametersDefinitions(parametersDefinitions *low.ParameterDefinitions) *ParameterDefinitions {
 	pd := new(ParameterDefinitions)
 	pd.low = parametersDefinitions
@@ -37,6 +45,7 @@ func NewParametersDefinitions(parametersDefinitions *low.ParameterDefinitions) *
 	return pd
 }
 
+// GoLow returns the low-level ParameterDefinitions instance that backs the low-level one.
 func (p *ParameterDefinitions) GoLow() *low.ParameterDefinitions {
 	return p.low
 }