Skip to content

Commit ed766f5

Browse files
author
Reuven
committed
documentation
1 parent 52968c5 commit ed766f5

43 files changed

Lines changed: 44 additions & 44 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎diff/callbacks_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"github.com/getkin/kin-openapi/openapi3"
77
)
88

9-
// CallbacksDiff is a diff between callback objects: https://swagger.io/specification/#callback-object
9+
// CallbacksDiff describes the changes between a pair of callback objects: https://swagger.io/specification/#callback-object
1010
type CallbacksDiff struct {
1111
Added StringList `json:"added,omitempty" yaml:"added,omitempty"`
1212
Deleted StringList `json:"deleted,omitempty" yaml:"deleted,omitempty"`

‎diff/components_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package diff
22

33
import "github.com/getkin/kin-openapi/openapi3"
44

5-
// ComponentsDiff is the diff between two component objects: https://swagger.io/specification/#components-object
5+
// ComponentsDiff describes the changes between a pair of component objects: https://swagger.io/specification/#components-object
66
type ComponentsDiff struct {
77
SchemasDiff *SchemasDiff `json:"schemas,omitempty" yaml:"schemas,omitempty"`
88
ParametersDiff *ParametersDiff `json:"parameters,omitempty" yaml:"parameters,omitempty"`

‎diff/contact.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package diff
22

33
import "github.com/getkin/kin-openapi/openapi3"
44

5-
// ContactDiff is the diff between two contact objects: https://swagger.io/specification/#contact-object
5+
// ContactDiff describes the changes between a pair of contact objects: https://swagger.io/specification/#contact-object
66
type ContactDiff struct {
77
Added bool `json:"added,omitempty" yaml:"added,omitempty"`
88
Deleted bool `json:"deleted,omitempty" yaml:"deleted,omitempty"`

‎diff/content_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"github.com/getkin/kin-openapi/openapi3"
77
)
88

9-
// ContentDiff is the diff between two content objects each containing a media type object: https://swagger.io/specification/#media-type-object
9+
// ContentDiff describes the changes between a pair of content objects each containing a media type object: https://swagger.io/specification/#media-type-object
1010
type ContentDiff struct {
1111
MediaTypeAdded bool `json:"mediaTypeAdded,omitempty" yaml:"mediaTypeAdded,omitempty"`
1212
MediaTypeDeleted bool `json:"mediaTypeDeleted,omitempty" yaml:"mediaTypeDeleted,omitempty"`

‎diff/diff.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ package diff
22

33
import "github.com/getkin/kin-openapi/openapi3"
44

5-
// Diff describes changes between two OpenAPI specifications including a summary of the changes
5+
// Diff describes the changes between a pair of OpenAPI specifications including a summary of the changes
66
type Diff struct {
77
SpecDiff *SpecDiff `json:"spec,omitempty" yaml:"spec,omitempty"`
88
Summary *Summary `json:"summary,omitempty" yaml:"summary,omitempty"`
99
}
1010

1111
/*
12-
Get calculates the diff between two OpenAPI specifications.
12+
Get calculates the diff between a pair of OpenAPI specifications.
1313
References should be resolved before calling this function.
1414
This is normally done automatically by loaders.
1515
See https://swagger.io/docs/specification/using-ref/ and https://pkg.go.dev/github.com/getkin/kin-openapi/openapi3#SwaggerLoader.ResolveRefsIn.

‎diff/encoding_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"github.com/getkin/kin-openapi/openapi3"
55
)
66

7-
// EncodingDiff is a diff between encoding objects: https://swagger.io/specification/#encoding-object
7+
// EncodingDiff describes the changes betweena pair of encoding objects: https://swagger.io/specification/#encoding-object
88
type EncodingDiff struct {
99
ContentTypeDiff *ValueDiff `json:"contentType,omitempty" yaml:"contentType,omitempty"`
1010
HeadersDiff *HeadersDiff `json:"headers,omitempty" yaml:"headers,omitempty"`

‎diff/encodings_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package diff
22

33
import "github.com/getkin/kin-openapi/openapi3"
44

5-
// EncodingsDiff is a diff between two sets of encoding objects: https://swagger.io/specification/#encoding-object
5+
// EncodingsDiff describes the changes between a pair of sets of encoding objects: https://swagger.io/specification/#encoding-object
66
type EncodingsDiff struct {
77
Added StringList `json:"added,omitempty" yaml:"added,omitempty"`
88
Deleted StringList `json:"deleted,omitempty" yaml:"deleted,omitempty"`

‎diff/enum_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"reflect"
55
)
66

7-
// EnumDiff is the diff between two enums
7+
// EnumDiff describes the changes between a pair of enums
88
type EnumDiff struct {
99
Added EnumValues `json:"added,omitempty" yaml:"added,omitempty"`
1010
Deleted EnumValues `json:"deleted,omitempty" yaml:"deleted,omitempty"`

‎diff/example_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"github.com/getkin/kin-openapi/openapi3"
55
)
66

7-
// ExampleDiff is a diff between example objects: https://swagger.io/specification/#example-object
7+
// ExampleDiff describes the changes between a pair of example objects: https://swagger.io/specification/#example-object
88
type ExampleDiff struct {
99
ExtensionsDiff *ExtensionsDiff `json:"extensions,omitempty" yaml:"extensions,omitempty"`
1010
SummaryDiff *ValueDiff `json:"summary,omitempty" yaml:"summary,omitempty"`

‎diff/examples_diff.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"github.com/getkin/kin-openapi/openapi3"
77
)
88

9-
// ExamplesDiff is a diff between two sets of example objects: https://swagger.io/specification/#example-object
9+
// ExamplesDiff describes the changes between a pair of sets of example objects: https://swagger.io/specification/#example-object
1010
type ExamplesDiff struct {
1111
Added StringList `json:"added,omitempty" yaml:"added,omitempty"`
1212
Deleted StringList `json:"deleted,omitempty" yaml:"deleted,omitempty"`

0 commit comments

Comments
 (0)