Skip to main content

osapi controller endpoint

List, describe and validate the controller's own endpoints, and print their DSL. osapi cli command get --name controller endpoint shows the same.

Group​

Namecontroller endpoint
DescriptionList, describe and validate the controller's own endpoints, and print their DSL

osapi controller endpoint list​

Methodlist
DescriptionList the endpoint groups this binary has

osapi controller endpoint get​

Methodget
DescriptionDescribe one endpoint group: its routes, permissions and operation IDs
Refusesno name

Flags (1)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe endpoint group, such as agent

osapi controller endpoint openapi get​

Methodopenapi get
DescriptionPrint the group's part of the OpenAPI spec, as YAML
Refusesno name

Flags (1)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe endpoint group, such as agent

osapi controller endpoint create​

Methodcreate
DescriptionWrite a new endpoint group that builds and passes its tests
Refusesno name, no description

Flags (2)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe group's name: its path segment and CLI group
--descriptionstringrequiredWhat the group is, in one line

osapi controller endpoint spec get​

Methodspec get
DescriptionPrint the endpoint DSL: each option, method, refinement, error and field tag

osapi controller endpoint validate​

Methodvalidate
DescriptionCheck every endpoint group against the rules of a definition