What to write about a connected database, and the schema to write it from
GET
/api/v1/learn/sources/{name}/description-brief
const url = 'http://localhost:11044/api/v1/learn/sources/example/description-brief';const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:11044/api/v1/learn/sources/example/description-brief \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Name of the connected database to brief on, as listed by GET /api/v1/learn/sources; 404 when no reachable connected database has that name
Query Parameters
Section titled “Query Parameters”consent
string
How much the drafter may read, case-insensitive: METADATA (schema only; the default when omitted or unrecognised) or SAMPLE_ROWS (a model may also read example rows). DISTINCT_VALUES is refused with 400 here
Responses
Section titled “Responses”No such connected database, or it is unreachable
Media typeapplication/json
A refusal carrying only its explanation, with no code to branch on
object
error
required
What went wrong, written to be shown. Carries the underlying driver’s or parser’s own message where there is one
string
Example generated
{ "error": "example"}