Help us shape the future of Go! Take the 2026 Go Developer Survey

openapiref

package
v1.10.0-alpha.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package openapiref resolves local OpenAPI component reference identity.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Name

func Name(ref, prefix string) (string, error)

Name resolves a fragment-only URI reference under a component prefix such as "#/components/schemas/". It decodes URI escapes once before JSON Pointer escapes and requires exactly one nonempty final token. Component-name admission is separate: valid pointer tokens need not be valid OpenAPI component keys.

Types

type Object

type Object struct {
	// Ref is a local reference to a request body, response, or header component.
	Ref string `json:"$ref"`
	// Description overrides the target description at this occurrence.
	Description *string `json:"description,omitzero"`
	// Summary overrides the target summary when that object supports summaries.
	Summary *string `json:"summary,omitzero"`
}

Object identifies a reusable OpenAPI object and its occurrence annotations. Nil annotations inherit; a pointer to an empty string explicitly clears one.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL