schemas
Creates, updates, deletes, gets or lists a schemas resource.
Overview
| Name | schemas |
| Type | Resource |
| Id | databricks_workspace.realtimeserving.schemas |
Fields
The following fields are returned by SELECT queries:
- getopenapi
The OpenAPI spec for the invocation schema was fetched successfully
| Name | Datatype | Description |
|---|---|---|
info | object | |
openapi | string | |
paths | object | |
servers | array |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
getopenapi | select | deployment_name | Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for the supported paths, input and output format and datatypes. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
deployment_name | string | The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc) |
SELECT examples
- getopenapi
Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for the supported paths, input and output format and datatypes.
SELECT
info,
openapi,
paths,
servers
FROM databricks_workspace.realtimeserving.schemas
WHERE deployment_name = '{{ deployment_name }}' -- required;