Skip to main content

Get

Print the group's part of the OpenAPI spec, as YAML.

It prints the spec as the definition makes it. Read it beside the hand-written spec of the group to compare the prose. TestEndpointParity compares the rest.

osapi controller endpoint openapi get [flags]

Examples​

osapi controller endpoint openapi get --name agent

Flags​

FlagDescriptionDefault
--nameThe endpoint group, such as agent (required)

Global flags​

FlagDescriptionDefault
-d, --debugEnable or disable debug mode
-j, --jsonEnable JSON output
-f, --osapi-filePath to config file/etc/osapi/osapi.yaml

Output tells how the result is printed, and what --json gives.