curl --request POST \
--url https://developer.synq.io/api/queries/v1/describe-resolver-ql \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://developer.synq.io/api/queries/v1/describe-resolver-ql"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://developer.synq.io/api/queries/v1/describe-resolver-ql', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/queries/v1/describe-resolver-ql",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/queries/v1/describe-resolver-ql"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/queries/v1/describe-resolver-ql")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/queries/v1/describe-resolver-ql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"functions": [
{
"name": "<string>",
"category": "<string>",
"doc": "<string>",
"variadic": true,
"defaultKwarg": "<string>",
"positional": [
{
"name": "<string>",
"type": "<string>",
"required": true,
"enumDomain": "<string>",
"doc": "<string>"
}
],
"kwargs": [
{
"name": "<string>",
"type": "<string>",
"required": true,
"enumDomain": "<string>",
"doc": "<string>"
}
]
}
],
"categories": [
"<string>"
],
"enumDomains": {}
}DescribeResolverQl
Describe the ResolverQL this deployment accepts: every function with its arguments and documentation, the category order to group them by, and the accepted values of every enum-typed argument.
Read it before authoring a selection, and validate against it rather than against a copy compiled into your client. The language gains functions and accepted values as Coalesce Quality supports more, and a client working from its own table both misses what was added and refuses a query this server would compile.
Nothing is passed, and no permission is needed beyond being authenticated — so a client holding a narrow credential, one that may write a deployment rule but cannot read entities, can still find out how to write the selection it is being asked for.
Read it as an answer for your workspace, not as a constant. Most of it is
the same for everyone, but the entity types you defined yourself are part of
the language too: today they are reachable only through
ResolverQlEnumDomain.pattern, which is why that field exists, and named by
synq.entities.typedefs.v1.TypeDefsService.ListEntityTypeDefs.
Caching it for the life of your process is fine; re-read it after you add or rename an entity type of your own.
curl --request POST \
--url https://developer.synq.io/api/queries/v1/describe-resolver-ql \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://developer.synq.io/api/queries/v1/describe-resolver-ql"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://developer.synq.io/api/queries/v1/describe-resolver-ql', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/queries/v1/describe-resolver-ql",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/queries/v1/describe-resolver-ql"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/queries/v1/describe-resolver-ql")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/queries/v1/describe-resolver-ql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"functions": [
{
"name": "<string>",
"category": "<string>",
"doc": "<string>",
"variadic": true,
"defaultKwarg": "<string>",
"positional": [
{
"name": "<string>",
"type": "<string>",
"required": true,
"enumDomain": "<string>",
"doc": "<string>"
}
],
"kwargs": [
{
"name": "<string>",
"type": "<string>",
"required": true,
"enumDomain": "<string>",
"doc": "<string>"
}
]
}
],
"categories": [
"<string>"
],
"enumDomains": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The body is of type DescribeResolverQlRequest · object.
Response
Success
Every function the language has, ordered by name.
Show child attributes
Show child attributes
The categories a function's category names, in the order the product
presents them. Group the catalog by this rather than sorting the names.
The accepted values of every enum-typed argument, keyed by the name an
argument's enum_domain carries. A domain absent here places no
restriction on the argument beyond its type.
Show child attributes
Show child attributes