diff --git a/openapi3/callback.go b/openapi3/callback.go index 6246d6d8c..62cea72d8 100644 --- a/openapi3/callback.go +++ b/openapi3/callback.go @@ -26,7 +26,7 @@ func (c Callbacks) JSONLookup(token string) (interface{}, error) { } // Callback is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callbackObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object type Callback map[string]*PathItem // Validate returns an error if Callback does not comply with the OpenAPI spec. diff --git a/openapi3/components.go b/openapi3/components.go index 16b39f303..8abc3fe9c 100644 --- a/openapi3/components.go +++ b/openapi3/components.go @@ -10,7 +10,7 @@ import ( ) // Components is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#componentsObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#components-object type Components struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/discriminator.go b/openapi3/discriminator.go index 8eb296024..8ab344a84 100644 --- a/openapi3/discriminator.go +++ b/openapi3/discriminator.go @@ -7,7 +7,7 @@ import ( ) // Discriminator is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminatorObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object type Discriminator struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/doc.go b/openapi3/doc.go index fc2735cb7..41c9965c6 100644 --- a/openapi3/doc.go +++ b/openapi3/doc.go @@ -1,4 +1,4 @@ // Package openapi3 parses and writes OpenAPI 3 specification documents. // -// See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md +// See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md package openapi3 diff --git a/openapi3/encoding.go b/openapi3/encoding.go index 082d3f2ec..003833e16 100644 --- a/openapi3/encoding.go +++ b/openapi3/encoding.go @@ -9,7 +9,7 @@ import ( ) // Encoding is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#encodingObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#encoding-object type Encoding struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/example.go b/openapi3/example.go index e75d4d3d5..f4cbfc074 100644 --- a/openapi3/example.go +++ b/openapi3/example.go @@ -28,7 +28,7 @@ func (e Examples) JSONLookup(token string) (interface{}, error) { } // Example is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#exampleObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#example-object type Example struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/header.go b/openapi3/header.go index aefaa06a3..454fad51e 100644 --- a/openapi3/header.go +++ b/openapi3/header.go @@ -28,7 +28,7 @@ func (h Headers) JSONLookup(token string) (interface{}, error) { } // Header is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#headerObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#header-object type Header struct { Parameter } diff --git a/openapi3/info.go b/openapi3/info.go index c67f73ab8..72076095e 100644 --- a/openapi3/info.go +++ b/openapi3/info.go @@ -8,7 +8,7 @@ import ( ) // Info is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#info-object type Info struct { ExtensionProps `json:"-" yaml:"-"` @@ -58,7 +58,7 @@ func (info *Info) Validate(ctx context.Context, opts ...ValidationOption) error } // Contact is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#contactObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#contact-object type Contact struct { ExtensionProps `json:"-" yaml:"-"` @@ -85,7 +85,7 @@ func (contact *Contact) Validate(ctx context.Context, opts ...ValidationOption) } // License is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#licenseObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#license-object type License struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/link.go b/openapi3/link.go index 1040a0408..137aef309 100644 --- a/openapi3/link.go +++ b/openapi3/link.go @@ -28,7 +28,7 @@ func (links Links) JSONLookup(token string) (interface{}, error) { var _ jsonpointer.JSONPointable = (*Links)(nil) // Link is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#linkObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object type Link struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/media_type.go b/openapi3/media_type.go index 74c11b78c..8e3fef7e6 100644 --- a/openapi3/media_type.go +++ b/openapi3/media_type.go @@ -12,7 +12,7 @@ import ( ) // MediaType is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#mediaTypeObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#media-type-object type MediaType struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/openapi3.go b/openapi3/openapi3.go index 714f28030..d9506a9cd 100644 --- a/openapi3/openapi3.go +++ b/openapi3/openapi3.go @@ -9,7 +9,7 @@ import ( ) // T is the root of an OpenAPI v3 document -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oasObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-object type T struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/parameter.go b/openapi3/parameter.go index 9124d92a4..c55af474d 100644 --- a/openapi3/parameter.go +++ b/openapi3/parameter.go @@ -90,7 +90,7 @@ func (parameters Parameters) Validate(ctx context.Context, opts ...ValidationOpt } // Parameter is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameterObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object type Parameter struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/path_item.go b/openapi3/path_item.go index 5cba0a876..db83a0a5a 100644 --- a/openapi3/path_item.go +++ b/openapi3/path_item.go @@ -10,7 +10,7 @@ import ( ) // PathItem is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#pathItemObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object type PathItem struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/refs.go b/openapi3/refs.go index 7311c9d34..d36d562fe 100644 --- a/openapi3/refs.go +++ b/openapi3/refs.go @@ -9,7 +9,7 @@ import ( ) // Ref is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#referenceObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#reference-object type Ref struct { Ref string `json:"$ref" yaml:"$ref"` } diff --git a/openapi3/request_body.go b/openapi3/request_body.go index 225c3d3c7..baf7f81e8 100644 --- a/openapi3/request_body.go +++ b/openapi3/request_body.go @@ -28,7 +28,7 @@ func (r RequestBodies) JSONLookup(token string) (interface{}, error) { } // RequestBody is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#requestBodyObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object type RequestBody struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/response.go b/openapi3/response.go index d2f907d12..eaf8e57f8 100644 --- a/openapi3/response.go +++ b/openapi3/response.go @@ -13,7 +13,7 @@ import ( ) // Responses is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responsesObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responses-object type Responses map[string]*ResponseRef var _ jsonpointer.JSONPointable = (*Responses)(nil) @@ -68,7 +68,7 @@ func (responses Responses) JSONLookup(token string) (interface{}, error) { } // Response is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responseObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#response-object type Response struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/schema.go b/openapi3/schema.go index 67cc7dce0..c5af8536e 100644 --- a/openapi3/schema.go +++ b/openapi3/schema.go @@ -111,7 +111,7 @@ func (s SchemaRefs) JSONLookup(token string) (interface{}, error) { } // Schema is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schemaObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object type Schema struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/security_requirements.go b/openapi3/security_requirements.go index dcdad0c4d..3f5bd9510 100644 --- a/openapi3/security_requirements.go +++ b/openapi3/security_requirements.go @@ -28,7 +28,7 @@ func (srs SecurityRequirements) Validate(ctx context.Context, opts ...Validation } // SecurityRequirement is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securityRequirementObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object type SecurityRequirement map[string][]string func NewSecurityRequirement() SecurityRequirement { diff --git a/openapi3/security_scheme.go b/openapi3/security_scheme.go index 2b3235dfc..83330f24a 100644 --- a/openapi3/security_scheme.go +++ b/openapi3/security_scheme.go @@ -29,7 +29,7 @@ func (s SecuritySchemes) JSONLookup(token string) (interface{}, error) { var _ jsonpointer.JSONPointable = (*SecuritySchemes)(nil) // SecurityScheme is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object type SecurityScheme struct { ExtensionProps `json:"-" yaml:"-"` @@ -177,7 +177,7 @@ func (ss *SecurityScheme) Validate(ctx context.Context, opts ...ValidationOption } // OAuthFlows is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauthFlowsObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object type OAuthFlows struct { ExtensionProps `json:"-" yaml:"-"` @@ -234,7 +234,7 @@ func (flows *OAuthFlows) Validate(ctx context.Context, opts ...ValidationOption) } // OAuthFlow is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauthFlowObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flow-object type OAuthFlow struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/security_scheme_test.go b/openapi3/security_scheme_test.go index 5958c5330..48ea04604 100644 --- a/openapi3/security_scheme_test.go +++ b/openapi3/security_scheme_test.go @@ -30,7 +30,7 @@ func TestSecuritySchemaExample(t *testing.T) { } } -// from https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields-23 +// from https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#fixed-fields-23 var securitySchemeExamples = []securitySchemeExample{ { title: "Basic Authentication Sample", diff --git a/openapi3/server.go b/openapi3/server.go index 304799634..587e8e0e1 100644 --- a/openapi3/server.go +++ b/openapi3/server.go @@ -50,7 +50,7 @@ func (servers Servers) MatchURL(parsedURL *url.URL) (*Server, []string, string) } // Server is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#serverObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object type Server struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/tag.go b/openapi3/tag.go index f151e5032..b5cb7f899 100644 --- a/openapi3/tag.go +++ b/openapi3/tag.go @@ -32,7 +32,7 @@ func (tags Tags) Validate(ctx context.Context, opts ...ValidationOption) error { } // Tag is specified by OpenAPI/Swagger 3.0 standard. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#tagObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#tag-object type Tag struct { ExtensionProps `json:"-" yaml:"-"` diff --git a/openapi3/xml.go b/openapi3/xml.go index 4ed3d94eb..a55ff410d 100644 --- a/openapi3/xml.go +++ b/openapi3/xml.go @@ -7,7 +7,7 @@ import ( ) // XML is specified by OpenAPI/Swagger standard version 3. -// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xmlObject +// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object type XML struct { ExtensionProps `json:"-" yaml:"-"`