point to Origin

getkin · fenollp · Oct 21, 2024 · Aug 19, 2024 · Aug 20, 2024 · Aug 21, 2024
commit 7d41bd043950dffdb888a53d2b38f2a592876e6b
diff --git a/openapi3/callback.go b/openapi3/callback.go
@@ -9,7 +9,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object
 type Callback struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"-" yaml:"-"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	m map[string]*PathItem
 }

diff --git a/openapi3/components.go b/openapi3/components.go
@@ -25,6 +25,7 @@ type (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#components-object
 type Components struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Schemas         Schemas         `json:"schemas,omitempty" yaml:"schemas,omitempty"`
 	Parameters      ParametersMap   `json:"parameters,omitempty" yaml:"parameters,omitempty"`
@@ -94,6 +95,7 @@ func (components *Components) UnmarshalJSON(data []byte) error {
 		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
+	delete(x.Extensions, "origin")
 	delete(x.Extensions, "schemas")
 	delete(x.Extensions, "parameters")
 	delete(x.Extensions, "headers")
@@ -110,6 +112,106 @@ func (components *Components) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
+// TODO: replace these unmarshallers with a generic one
+func (callbacks *Callbacks) UnmarshalJSON(data []byte) error {
+	type CallbacksBis Callbacks
+	var x CallbacksBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*callbacks = Callbacks(x)
+	return nil
+}
+
+func (examples *Examples) UnmarshalJSON(data []byte) error {
+	type ExamplesBis Examples
+	var x ExamplesBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*examples = Examples(x)
+	return nil
+}
+
+func (headers *Headers) UnmarshalJSON(data []byte) error {
+	type HeadersBis Headers
+	var x HeadersBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*headers = Headers(x)
+	return nil
+}
+
+func (links *Links) UnmarshalJSON(data []byte) error {
+	type LinksBis Links
+	var x LinksBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*links = Links(x)
+	return nil
+}
+
+func (parametersMap *ParametersMap) UnmarshalJSON(data []byte) error {
+	type ParametersMapBis ParametersMap
+	var x ParametersMapBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*parametersMap = ParametersMap(x)
+	return nil
+}
+
+func (requestBodies *RequestBodies) UnmarshalJSON(data []byte) error {
+	type RequestBodiesBis RequestBodies
+	var x RequestBodiesBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*requestBodies = RequestBodies(x)
+	return nil
+}
+
+func (responseBodies *ResponseBodies) UnmarshalJSON(data []byte) error {
+	type ResponseBodiesBis ResponseBodies
+	var x ResponseBodiesBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*responseBodies = ResponseBodies(x)
+	return nil
+}
+
+func (schemas *Schemas) UnmarshalJSON(data []byte) error {
+	type SchemasBis Schemas
+	var x SchemasBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*schemas = Schemas(x)
+	return nil
+}
+
+func (securitySchemes *SecuritySchemes) UnmarshalJSON(data []byte) error {
+	type SecuritySchemesBis SecuritySchemes
+	var x SecuritySchemesBis
+	if err := json.Unmarshal(data, &x); err != nil {
+		return unmarshalError(err)
+	}
+	delete(x, "origin")
+	*securitySchemes = SecuritySchemes(x)
+	return nil
+}
+
 // Validate returns an error if Components does not comply with the OpenAPI spec.
 func (components *Components) Validate(ctx context.Context, opts ...ValidationOption) (err error) {
 	ctx = WithValidationOptions(ctx, opts...)

diff --git a/openapi3/info.go b/openapi3/info.go
@@ -10,7 +10,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#info-object
 type Info struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Title          string   `json:"title" yaml:"title"` // Required
 	Description    string   `json:"description,omitempty" yaml:"description,omitempty"`

diff --git a/openapi3/license.go b/openapi3/license.go
@@ -10,6 +10,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#license-object
 type License struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Name string `json:"name" yaml:"name"` // Required
 	URL  string `json:"url,omitempty" yaml:"url,omitempty"`
@@ -45,6 +46,7 @@ func (license *License) UnmarshalJSON(data []byte) error {
 		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
+	delete(x.Extensions, "origin")
 	delete(x.Extensions, "name")
 	delete(x.Extensions, "url")
 	if len(x.Extensions) == 0 {

diff --git a/openapi3/media_type.go b/openapi3/media_type.go
@@ -14,7 +14,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#media-type-object
 type MediaType struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Schema   *SchemaRef           `json:"schema,omitempty" yaml:"schema,omitempty"`
 	Example  any                  `json:"example,omitempty" yaml:"example,omitempty"`

diff --git a/openapi3/operation.go b/openapi3/operation.go
@@ -14,7 +14,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object
 type Operation struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	// Optional tags for documentation.
 	Tags []string `json:"tags,omitempty" yaml:"tags,omitempty"`

diff --git a/openapi3/origin.go b/openapi3/origin.go
@@ -1,7 +1,7 @@
 package openapi3
 
 type Origin struct {
-	Key    Location            `json:"key,omitempty" yaml:"key,omitempty"`
+	Key    *Location           `json:"key,omitempty" yaml:"key,omitempty"`
 	Fields map[string]Location `json:"fields,omitempty" yaml:"fields,omitempty"`
 }
 

diff --git a/openapi3/parameter.go b/openapi3/parameter.go
@@ -73,7 +73,7 @@ func (parameters Parameters) Validate(ctx context.Context, opts ...ValidationOpt
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object
 type Parameter struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Name            string     `json:"name,omitempty" yaml:"name,omitempty"`
 	In              string     `json:"in,omitempty" yaml:"in,omitempty"`

diff --git a/openapi3/path_item.go b/openapi3/path_item.go
@@ -12,7 +12,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object
 type PathItem struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Ref         string     `json:"$ref,omitempty" yaml:"$ref,omitempty"`
 	Summary     string     `json:"summary,omitempty" yaml:"summary,omitempty"`

diff --git a/openapi3/paths.go b/openapi3/paths.go
@@ -11,7 +11,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#paths-object
 type Paths struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"-" yaml:"-"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	m map[string]*PathItem
 }

diff --git a/openapi3/ref.go b/openapi3/ref.go
@@ -5,6 +5,6 @@ package openapi3
 // Ref is specified by OpenAPI/Swagger 3.0 standard.
 // 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"`
-	Origin Origin `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Ref    string  `json:"$ref" yaml:"$ref"`
+	Origin *Origin `json:"origin,omitempty" yaml:"origin,omitempty"`
 }
diff --git a/openapi3/refs.go b/openapi3/refs.go
diff --git a/openapi3/refs.tmpl b/openapi3/refs.tmpl
@@ -19,7 +19,7 @@ type {{ $type.Name }}Ref struct {
 	// Extensions only captures fields starting with 'x-' as no other fields
 	// are allowed by the openapi spec.
 	Extensions map[string]any
-	Origin     Origin
+	Origin     *Origin
 
 	Ref   string
 	Value *{{ $type.Name }}

diff --git a/openapi3/request_body.go b/openapi3/request_body.go
@@ -10,7 +10,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object
 type RequestBody struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Description string  `json:"description,omitempty" yaml:"description,omitempty"`
 	Required    bool    `json:"required,omitempty" yaml:"required,omitempty"`

diff --git a/openapi3/response.go b/openapi3/response.go
@@ -12,7 +12,7 @@ import (
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responses-object
 type Responses struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"-" yaml:"-"`
+	Origin     *Origin        `json:"-" yaml:"-"`
 
 	m map[string]*ResponseRef
 }
@@ -103,7 +103,7 @@ func (responses *Responses) Validate(ctx context.Context, opts ...ValidationOpti
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#response-object
 type Response struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	Description *string `json:"description,omitempty" yaml:"description,omitempty"`
 	Headers     Headers `json:"headers,omitempty" yaml:"headers,omitempty"`

diff --git a/openapi3/schema.go b/openapi3/schema.go
@@ -82,7 +82,7 @@ func (s SchemaRefs) JSONLookup(token string) (any, error) {
 // See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object
 type Schema struct {
 	Extensions map[string]any `json:"-" yaml:"-"`
-	Origin     Origin         `json:"origin,omitempty" yaml:"origin,omitempty"`
+	Origin     *Origin        `json:"origin,omitempty" yaml:"origin,omitempty"`
 
 	OneOf        SchemaRefs    `json:"oneOf,omitempty" yaml:"oneOf,omitempty"`
 	AnyOf        SchemaRefs    `json:"anyOf,omitempty" yaml:"anyOf,omitempty"`