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
| |
|---|
| Name | controller endpoint |
| Description | List, describe and validate the controller's own endpoints, and print their DSL |
| |
|---|
| Method | list |
| Description | List the endpoint groups this binary has |
| |
|---|
| Method | get |
| Description | Describe one endpoint group: its routes, permissions and operation IDs |
| Refuses | no name |
Flags (1)
| FLAG | TYPE | VALIDATE | HELP |
|---|
| --name | string | required | The endpoint group, such as agent |
| |
|---|
| Method | openapi get |
| Description | Print the group's part of the OpenAPI spec, as YAML |
| Refuses | no name |
Flags (1)
| FLAG | TYPE | VALIDATE | HELP |
|---|
| --name | string | required | The endpoint group, such as agent |
| |
|---|
| Method | create |
| Description | Write a new endpoint group that builds and passes its tests |
| Refuses | no name, no description |
Flags (2)
| FLAG | TYPE | VALIDATE | HELP |
|---|
| --name | string | required | The group's name: its path segment and CLI group |
| --description | string | required | What the group is, in one line |
| |
|---|
| Method | spec get |
| Description | Print the endpoint DSL: each option, method, refinement, error and field tag |
| |
|---|
| Method | validate |
| Description | Check every endpoint group against the rules of a definition |