Documentation
¶
Overview ¶
Package openapi embeds OwlMail's canonical OpenAPI 3.1 documents.
Index ¶
- func JSON(serverURL string) ([]byte, error)
- func MultiuserJSON(serverURL string) ([]byte, error)
- func MultiuserJSONWithHeaders(serverURL, subjectHeader, emailHeader, verifiedHeader string) ([]byte, error)
- func MultiuserYAML(serverURL string) ([]byte, error)
- func MultiuserYAMLWithHeaders(serverURL, subjectHeader, emailHeader, verifiedHeader string) ([]byte, error)
- func YAML(serverURL string) ([]byte, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func JSON ¶
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
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 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.
Types ¶
This section is empty.