Merge pull request #1385 from max107/fix_info_todo

fix(expand): copy full info from spec

Author: tdakkota

openapi/Info.go

@@ -0,0 +1,67 @@
+package openapi
+
+import "github.com/ogen-go/ogen/jsonschema"
+
+type (
+	// Extensions is a map of OpenAPI extensions.
+	//
+	// See https://spec.openapis.org/oas/v3.1.0#specification-extensions.
+	Extensions = jsonschema.Extensions
+)
+
+// Info provides metadata about the API.
+//
+// The metadata MAY be used by the clients if needed,
+// and MAY be presented in editing or documentation generation tools for convenience.
+//
+// See https://spec.openapis.org/oas/v3.1.0#info-object.
+type Info struct {
+	// REQUIRED. The title of the API.
+	Title string `json:"title" yaml:"title"`
+	// A short summary of the API.
+	Summary string `json:"summary,omitempty" yaml:"summary,omitempty"`
+	// A short description of the API.
+	// CommonMark syntax MAY be used for rich text representation.
+	Description string `json:"description,omitempty" yaml:"description,omitempty"`
+	// A URL to the Terms of Service for the API. MUST be in the format of a URL.
+	TermsOfService string `json:"termsOfService,omitempty" yaml:"termsOfService,omitempty"`
+	// The contact information for the exposed API.
+	Contact *Contact `json:"contact,omitempty" yaml:"contact,omitempty"`
+	// The license information for the exposed API.
+	License *License `json:"license,omitempty" yaml:"license,omitempty"`
+	// REQUIRED. The version of the OpenAPI document.
+	Version string `json:"version" yaml:"version"`
+
+	// Specification extensions.
+	Extensions Extensions `json:"-" yaml:",inline"`
+}
+
+// Contact information for the exposed API.
+//
+// See https://spec.openapis.org/oas/v3.1.0#contact-object.
+type Contact struct {
+	// The identifying name of the contact person/organization.
+	Name string `json:"name,omitempty" yaml:"name,omitempty"`
+	// The URL pointing to the contact information.
+	URL string `json:"url,omitempty" yaml:"url,omitempty"`
+	// The email address of the contact person/organization.
+	Email string `json:"email,omitempty" yaml:"email,omitempty"`
+
+	// Specification extensions.
+	Extensions Extensions `json:"-" yaml:",inline"`
+}
+
+// License information for the exposed API.
+//
+// See https://spec.openapis.org/oas/v3.1.0#license-object.
+type License struct {
+	// REQUIRED. The license name used for the API.
+	Name string `json:"name" yaml:"name"`
+	// An SPDX license expression for the API.
+	Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
+	// A URL to the license used for the API.
+	URL string `json:"url,omitempty" yaml:"url,omitempty"`
+
+	// Specification extensions.
+	Extensions Extensions `json:"-" yaml:",inline"`
+}

openapi/api.go

@@ -17,6 +17,7 @@ type API struct {
 	Operations []*Operation
 	Webhooks   []Webhook
 	Components *Components
+	Info       Info
 }
 
 // Components represent parsed components of OpenAPI spec.

openapi/parser/expand.go

@@ -47,12 +47,7 @@ func (e *expander) Spec(api *openapi.API) (spec *ogen.Spec, err error) {
 		}
 	}
 	spec.Tags = tags
-
-	// FIXME(tdakkota): store actual information
-	spec.Info = ogen.Info{
-		Title:   "Expanded spec",
-		Version: "v0.1.0",
-	}
+	spec.Info = fromOpenapiInfo(api.Info)
 
 	if servers := api.Servers; len(servers) > 0 {
 		expanded := make([]ogen.Server, len(servers))

openapi/parser/parse_info.go

@@ -0,0 +1,52 @@
+package parser
+
+import (
+	"github.com/ogen-go/ogen"
+	"github.com/ogen-go/ogen/openapi"
+)
+
+func fromOpenapiInfo(info openapi.Info) ogen.Info {
+	result := ogen.Info{
+		Title:          info.Title,
+		Summary:        info.Title,
+		Description:    info.Description,
+		TermsOfService: info.TermsOfService,
+		Version:        info.Version,
+		Extensions:     info.Extensions,
+	}
+
+	if info.Contact != nil {
+		val := ogen.Contact(*info.Contact)
+		result.Contact = &val
+	}
+
+	if info.License != nil {
+		val := ogen.License(*info.License)
+		result.License = &val
+	}
+
+	return result
+}
+
+func fromOgenInfo(info ogen.Info) openapi.Info {
+	result := openapi.Info{
+		Title:          info.Title,
+		Summary:        info.Title,
+		Description:    info.Description,
+		TermsOfService: info.TermsOfService,
+		Version:        info.Version,
+		Extensions:     info.Extensions,
+	}
+
+	if info.Contact != nil {
+		val := openapi.Contact(*info.Contact)
+		result.Contact = &val
+	}
+
+	if info.License != nil {
+		val := openapi.License(*info.License)
+		result.License = &val
+	}
+
+	return result
+}

openapi/parser/parser.go

@@ -146,6 +146,7 @@ func Parse(spec *ogen.Spec, s Settings) (_ *openapi.API, rerr error) {
 		Operations: p.operations,
 		Webhooks:   webhooks,
 		Components: components,
+		Info:       fromOgenInfo(p.spec.Info),
 	}, nil
 }