Documentation
¶
Overview ¶
Package openapi exposes embedded OpenAPI contracts for stable HTTP APIs.
YAML documents are the canonical sources. JSON is rendered from the same embedded bytes so served formats stay in sync.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IDPJSON ¶
func IDPJSON() []byte
IDPJSON returns the embedded public IDP OpenAPI document rendered as JSON.
func IDPYAML ¶
func IDPYAML() []byte
IDPYAML returns the embedded public IDP OpenAPI document in YAML format.
func ManagementJSON ¶
func ManagementJSON() []byte
ManagementJSON returns the embedded management OpenAPI document rendered as JSON.
func ManagementYAML ¶
func ManagementYAML() []byte
ManagementYAML returns the embedded management OpenAPI document in YAML format.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package client exposes the supported production boundary around selected generated OpenAPI clients.
|
Package client exposes the supported production boundary around selected generated OpenAPI clients. |
|
generated
|
|
|
idp
Package idp provides primitives to interact with the openapi HTTP API.
|
Package idp provides primitives to interact with the openapi HTTP API. |
|
management
Package management provides primitives to interact with the openapi HTTP API.
|
Package management provides primitives to interact with the openapi HTTP API. |
|
Package requesttest provides reusable OpenAPI request-contract helpers for handler tests.
|
Package requesttest provides reusable OpenAPI request-contract helpers for handler tests. |
|
Package requestvalidation provides OpenAPI request validation for selected HTTP boundaries.
|
Package requestvalidation provides OpenAPI request validation for selected HTTP boundaries. |
Click to show internal directories.
Click to hide internal directories.