Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

merger

package

Go to main page

Versions in this module

v1

v1.3.0

Apr 12, 2026

v1.2.0

Apr 12, 2026

v1.1.0

Apr 12, 2026

Changes in this version

+ func RewriteRefs(value any, prefix string) any

type MergerConfig

+ CollapseServiceTags bool

v1.0.2

Dec 8, 2025

Changes in this version

+ func ApplyRouting(paths map[string]PathItem, manifest *farp.SchemaManifest) map[string]PathItem

+ func GetSecuritySchemeSummary(schemes map[string]SecurityScheme) string

+ func MergeOperationSecurity(existingSecurity []map[string][]string, newSecurity []map[string][]string, ...) []map[string][]string

+ func PrefixTags(tags []string, prefix string) []string

+ func SortChannels(channels map[string]Channel) []string

+ func SortGRPCServices(services map[string]GRPCService) []string

+ func SortProcedures(procedures map[string]ORPCProcedure) []string

+ func ValidateSecurityScheme(name string, scheme SecurityScheme) error

+ type AsyncAPIMergeResult struct

+ Conflicts []Conflict

+ ExcludedServices []string

+ IncludedServices []string

+ Spec *AsyncAPISpec

+ Warnings []string

+ type AsyncAPIMerger struct

+ func NewAsyncAPIMerger(config MergerConfig) *AsyncAPIMerger

+ func (m *AsyncAPIMerger) MergeAsyncAPI(schemas []AsyncAPIServiceSchema) (*AsyncAPIMergeResult, error)

+ type AsyncAPIServiceSchema struct

+ Manifest *farp.SchemaManifest

+ Parsed *AsyncAPISpec

+ Schema any

+ type AsyncAPISpec struct

+ AsyncAPI string

+ Channels map[string]Channel

+ Components *AsyncComponents

+ Extensions map[string]any

+ Info Info

+ Security []map[string][]string

+ Servers map[string]AsyncServer

+ func ParseAsyncAPISchema(raw any) (*AsyncAPISpec, error)

+ type AsyncComponents struct

+ Messages map[string]map[string]any

+ Schemas map[string]map[string]any

+ SecuritySchemes map[string]AsyncSecurityScheme

+ type AsyncSecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows map[string]any

+ In string

+ Name string

+ OpenIdConnectURL string

+ Scheme string

+ Type string

+ type AsyncServer struct

+ Bindings map[string]any

+ Description string

+ Protocol string

+ URL string

+ Variables map[string]any

+ type Channel struct

+ Bindings map[string]any

+ Description string

+ Extensions map[string]any

+ Parameters map[string]any

+ Publish *Operation

+ Subscribe *Operation

+ type Components struct

+ Headers map[string]Header

+ Parameters map[string]Parameter

+ RequestBodies map[string]RequestBody

+ Responses map[string]Response

+ Schemas map[string]map[string]any

+ SecuritySchemes map[string]SecurityScheme

+ func PrefixComponentNames(components *Components, prefix string) *Components

+ type Conflict struct

+ Item string

+ Resolution string

+ Services []string

+ Strategy farp.ConflictStrategy

+ Type ConflictType

+ type ConflictType string

+ const ConflictTypeComponent

+ const ConflictTypeOperationID

+ const ConflictTypePath

+ const ConflictTypeSecurityScheme

+ const ConflictTypeTag

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type Example struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value any

+ type GRPCEnum struct

+ Description string

+ Name string

+ Values map[string]int

+ type GRPCField struct

+ Name string

+ Number int

+ Optional bool

+ Repeated bool

+ Type string

+ type GRPCMergeResult struct

+ Conflicts []Conflict

+ ExcludedServices []string

+ IncludedServices []string

+ Spec *GRPCSpec

+ Warnings []string

+ type GRPCMerger struct

+ func NewGRPCMerger(config MergerConfig) *GRPCMerger

+ func (m *GRPCMerger) MergeGRPC(schemas []GRPCServiceSchema) (*GRPCMergeResult, error)

+ type GRPCMessage struct

+ Description string

+ Fields map[string]GRPCField

+ Name string

+ Options map[string]any

+ type GRPCMethod struct

+ ClientStreaming bool

+ Description string

+ InputType string

+ Name string

+ Options map[string]any

+ OutputType string

+ ServerStreaming bool

+ type GRPCSecurityScheme struct

+ Description string

+ KeyName string

+ Metadata map[string]any

+ Scopes map[string]string

+ TLS *GRPCTLSConfig

+ TokenURL string

+ Type string

+ type GRPCService struct

+ Description string

+ Methods map[string]GRPCMethod

+ Name string

+ Options map[string]any

+ type GRPCServiceSchema struct

+ Manifest *farp.SchemaManifest

+ Parsed *GRPCSpec

+ Schema any

+ type GRPCSpec struct

+ Enums map[string]GRPCEnum

+ Imports []string

+ Messages map[string]GRPCMessage

+ Package string

+ SecuritySchemes map[string]GRPCSecurityScheme

+ Services map[string]GRPCService

+ Syntax string

+ func ParseGRPCSchema(raw any) (*GRPCSpec, error)

+ type GRPCTLSConfig struct

+ InsecureSkipVerify bool

+ RequireClientCert bool

+ ServerName string

+ type Header struct

+ Description string

+ Schema map[string]any

+ type Info struct

+ Contact *Contact

+ Description string

+ Extensions map[string]any

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ type License struct

+ Name string

+ URL string

+ type MediaType struct

+ Example any

+ Examples map[string]Example

+ Schema map[string]any

+ type MergeResult struct

+ Conflicts []Conflict

+ ExcludedServices []string

+ IncludedServices []string

+ Spec *OpenAPISpec

+ Warnings []string

+ type Merger struct

+ func NewMerger(config MergerConfig) *Merger

+ func (m *Merger) Merge(schemas []ServiceSchema) (*MergeResult, error)

+ type MergerConfig struct

+ DefaultConflictStrategy farp.ConflictStrategy

+ IncludeServiceTags bool

+ MergedDescription string

+ MergedTitle string

+ MergedVersion string

+ Servers []Server

+ SortOutput bool

+ func DefaultMergerConfig() MergerConfig

+ type MultiProtocolMerger struct

+ func NewMultiProtocolMerger(config MergerConfig) *MultiProtocolMerger

+ func (m *MultiProtocolMerger) MergeAll(manifests []*farp.SchemaManifest, schemaFetcher func(string) (any, error)) (*MultiProtocolResult, error)

+ type MultiProtocolResult struct

+ AsyncAPI *AsyncAPIMergeResult

+ GRPC *GRPCMergeResult

+ IncludedServices map[farp.SchemaType][]string

+ ORPC *ORPCMergeResult

+ OpenAPI *MergeResult

+ Warnings []string

+ func (r *MultiProtocolResult) GetSummary() string

+ func (r *MultiProtocolResult) GetTotalConflicts() int

+ func (r *MultiProtocolResult) HasProtocol(schemaType farp.SchemaType) bool

+ type ORPCError struct

+ Code int

+ Description string

+ Message string

+ Schema map[string]any

+ type ORPCMergeResult struct

+ Conflicts []Conflict

+ ExcludedServices []string

+ IncludedServices []string

+ Spec *ORPCSpec

+ Warnings []string

+ type ORPCMerger struct

+ func NewORPCMerger(config MergerConfig) *ORPCMerger

+ func (m *ORPCMerger) MergeORPC(schemas []ORPCServiceSchema) (*ORPCMergeResult, error)

+ type ORPCProcedure struct

+ Batch bool

+ Description string

+ Errors []ORPCError

+ Extensions map[string]any

+ Input *ORPCSchema

+ Name string

+ Options map[string]any

+ Output *ORPCSchema

+ Streaming bool

+ type ORPCSchema struct

+ Ref string

+ Schema map[string]any

+ Type string

+ type ORPCSecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows map[string]any

+ In string

+ Name string

+ OpenIdConnectURL string

+ Scheme string

+ Type string

+ type ORPCServiceSchema struct

+ Manifest *farp.SchemaManifest

+ Parsed *ORPCSpec

+ Schema any

+ type ORPCSpec struct

+ Extensions map[string]any

+ Info Info

+ ORPC string

+ Procedures map[string]ORPCProcedure

+ Schemas map[string]any

+ Security []map[string][]string

+ SecuritySchemes map[string]ORPCSecurityScheme

+ Servers []Server

+ func ParseORPCSchema(raw any) (*ORPCSpec, error)

+ type OpenAPISpec struct

+ Components *Components

+ Extensions map[string]any

+ Info Info

+ OpenAPI string

+ Paths map[string]PathItem

+ Security []map[string][]string

+ Servers []Server

+ Tags []Tag

+ func ParseOpenAPISchema(raw any) (*OpenAPISpec, error)

+ type Operation struct

+ Deprecated bool

+ Description string

+ Extensions map[string]any

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses map[string]Response

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type Parameter struct

+ Description string

+ Example any

+ In string

+ Name string

+ Required bool

+ Schema map[string]any

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Extensions map[string]any

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Summary string

+ Trace *Operation

+ type RequestBody struct

+ Content map[string]MediaType

+ Description string

+ Extensions map[string]any

+ Required bool

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ Extensions map[string]any

+ Headers map[string]Header

+ type SecurityConfig struct

+ ExcludeSchemes []string

+ GlobalSecurity []map[string][]string

+ PrefixSchemeNames bool

+ PreserveOperationSecurity bool

+ RequiredSchemes []string

+ Strategy SecurityMergeStrategy

+ func DefaultSecurityConfig() SecurityConfig

+ type SecurityConflict struct

+ ConflictType string

+ OriginalSchemes map[string]SecurityScheme

+ Resolution string

+ SchemeName string

+ Services []string

+ type SecurityMergeInfo struct

+ AllSchemes map[string]SecurityScheme

+ CommonSchemes []string

+ Conflicts []SecurityConflict

+ SchemesByService map[string][]string

+ Strategy SecurityMergeStrategy

+ func MergeSecuritySchemes(serviceSchemas map[string]map[string]SecurityScheme, config SecurityConfig) (*SecurityMergeInfo, map[string]SecurityScheme, error)

+ type SecurityMergeStrategy string

+ const SecurityStrategyGlobal

+ const SecurityStrategyIntersection

+ const SecurityStrategyMostStrict

+ const SecurityStrategyPerService

+ const SecurityStrategyUnion

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ In string

+ Name string

+ OpenIdConnectURL string

+ Scheme string

+ Type string

+ type Server struct

+ Description string

+ URL string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ type ServiceSchema struct

+ Manifest *farp.SchemaManifest

+ Parsed *OpenAPISpec

+ Schema any

+ type Tag struct

+ Description string

+ Extensions map[string]any

+ Name string

+ func SortTags(tags []Tag) []Tag

v1.0.1

Nov 5, 2025

v1.0.0

Nov 5, 2025