All URIs are relative to https://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| SchemaGet | Get /schema | Get model schemata for data objects returned by this API. |
| SchemaWebsocketHelp | Get /schema/websocketHelp | Returns help text & subject list for websocket usage. |
interface{} SchemaGet(ctx, optional) Get model schemata for data objects returned by this API.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *SchemaGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a SchemaGetOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| model | optional.String | Optional model filter. If omitted, will return all models. |
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
interface{} SchemaWebsocketHelp(ctx, ) Returns help text & subject list for websocket usage.
This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]