The TypeAPI Root
| Property | Type | Description |
|---|---|---|
| baseUrl | String |
Optional the base url of the service, if provided the user does not need to provide a base url for your client |
| operations |
A map of operations which are provided by the API. The key of the operation should be separated by a dot to group operations into logical units i.e. product.getAll or enterprise.product.execute |
|
| security | Security |
Describes the authorization mechanism which is used by your API |
| INHERITED FROM typeschema:TypeSchema | ||
| definitions | ||
| import |
Allows to import other TypeSchema documents. It contains a map where the key is the namespace and the value points to a remote document. The value is a URL and a code generator should support at least the following schemes: file, http, https |
|
| root | String |
Specifies the root type of your specification, this must be a key which is available at the definitions map |