Kunin ang dokumentong ito

Mga parameter

Lingara-Versionheaderstringopsyonal

Ang bersyon ng API na gagamitin sa pagsagot sa kahilingang ito. Kung wala ito, makukuha ng access token ang bersyong naka-pin sa client nito, at makukuha ng kahilingang walang token ang kasalukuyang bersyon. Maaabot lang ang bersyong dine-develop pa sa pamamagitan ng pagpangalan dito. Ang hindi kilalang bersyon ay sinasagot ng 400 na may code na api_version_unknown. Inililista ng GET /v1/versions ang mga bersyon.

Mga tugon

200 Ang dokumentong OpenAPI

Mga error

410application/json

Itinigil na ang bersyon ng API na ginagamit sa pagsagot sa kahilingang ito. Magpadala ng suportadong bersyon sa Lingara-Version, o i-pin ang client sa ibang bersyon.

4XXapplication/json

Tinanggihan ang kahilingan. Sinasabi ng code kung bakit, at ipinapaliwanag ito ng error sa mga salita.

503application/json · text/plain

Pansamantalang hindi available ang serbisyo; subukang muli pagkatapos ng bilang ng segundong nasa Retry-After. Habang may maintenance, plain text ang body sa halip na ang error envelope.

codestringkailangan

Kung bakit tinanggihan ang request, bilang isang matatag na code na mapagbabatayan ng iyong programa: halimbawa insufficient_scope (403), rate_limited (429) at, para sa isang metered client, spend_cap_reached (402) at metered_billing_inactive (402).

errorstringkailangan

Halimbawa

curl "https://api.getlingara.com/v1/openapi.json"

const document = await client.getOpenApiDocument();
console.log(document.servedVersion, Object.keys(document));

let document = client.get_open_api_document().await?;
let keys: Vec<&String> = document.as_object().map(|o| o.keys().collect()).unwrap_or_default();
println!("{:?} {keys:?}", document.served_version());

doc, err := client.GetOpenAPIDocument(ctx)
if err != nil {
	return err
}
fmt.Println(doc.Value["openapi"], doc.ServedVersion)

import com.fasterxml.jackson.databind.JsonNode;
import com.getlingara.client.LingaraClient;

JsonNode document = client.getOpenApiDocument().body();
System.out.println(document.path("info").path("version").asText());

import com.getlingara.kotlin.LingaraClient
import kotlinx.serialization.json.jsonObject
import kotlinx.serialization.json.jsonPrimitive

val document = client.getOpenApiDocument().body
println(
    document
        .getValue("info")
        .jsonObject
        .getValue("version")
        .jsonPrimitive.content,
)

document = client.get_open_api_document
puts "#{document.value["openapi"]} #{document.served_version}"

// Needs no token: a client built without credentials can call it.
$document = $client->getOpenApiDocument()->value;
echo $document->info->title, ' ', $document->info->version, "\n";

Mas gusto ang library? Tingnan ang seksyong Mga library.