openapi

package
v0.15.0 Latest Latest
Warning

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

Go to latest
Published: Nov 13, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package openapi embeds OwlMail's canonical OpenAPI 3.1 documents.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func JSON

func JSON(serverURL string) ([]byte, error)

JSON returns the JSON contract with its first server URL set to the effective, base-path-aware API prefix.

func MultiuserJSON added in v0.14.0

func MultiuserJSON(serverURL string) ([]byte, error)

MultiuserJSON returns the isolated whitelist contract with default identity assertion header names. Servers use MultiuserJSONWithHeaders for their actual validated deployment configuration.

func MultiuserJSONWithHeaders added in v0.14.0

func MultiuserJSONWithHeaders(serverURL, subjectHeader, emailHeader, verifiedHeader string) ([]byte, error)

MultiuserJSONWithHeaders documents effective, already validated assertion names. This function never configures or relaxes the identity trust boundary.

func MultiuserYAML added in v0.14.0

func MultiuserYAML(serverURL string) ([]byte, error)

func MultiuserYAMLWithHeaders added in v0.14.0

func MultiuserYAMLWithHeaders(serverURL, subjectHeader, emailHeader, verifiedHeader string) ([]byte, error)

MultiuserYAMLWithHeaders renders the same semantic document as the JSON endpoint. YAML encoding quotes arbitrary header/path strings safely.

func YAML

func YAML(serverURL string) ([]byte, error)

YAML returns the YAML contract with its first server URL set to the effective, base-path-aware API prefix. SetBasePathname only accepts a normalized URL path; quoting it also keeps the emitted YAML unambiguous.

Types

This section is empty.

Directories

Path Synopsis
Command generate derives the isolated contract from unchanged standalone DTOs and an explicit operation whitelist.
Command generate derives the isolated contract from unchanged standalone DTOs and an explicit operation whitelist.

Jump to

Keyboard shortcuts

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