Service & Fähigkeiten-API

Bereitschaft zum Dienst. Ein entleerender Host antwortet mit 421 server_draining und Retry-After: 1. Ein Ausfall einer erforderlichen Abhängigkeit antwortet mit 500 not_ready und Retry-After. Ein aktives Datenbankschema, das diese Version nicht erfüllt (ein gewünschter Index fehlt oder ist länger als zwei Minuten anders), antwortet mit 500 schema_incompatible ohne Retry-After: Es wird nicht durch Warten behoben.

Durchsucht die offizielle screenRIG-Dokumentation, die Seiten von screenrig.ai/docs, die Problemtypen, die Preise und die übrigen Kundenseiten und liefert die am besten passenden Abschnitte, die beste zuerst, höchstens limit (standardmäßig 8). Öffentlich: Es sind keine Zugangsdaten nötig, und der Aufruf wird nie berechnet.

Die url eines Treffers ist seine Seite (mit dem Fragment des Abschnitts, wenn die Seite eines nennt), section ist die Überschrift und snippet zeigt den Text rund um den Treffer; lesen Sie die Seite oder den Abschnitt mit getDocsPage. Begrenzt auf 120 Anfragen pro Client-IP und Minute (IPv6 nach /64 gruppiert).

Der Korpus wird alle 15 Minuten neu geladen; vor dem ersten Laden antwortet die Route mit 500 not_ready und Retry-After.

Liefert eine Seite der offiziellen Dokumentation oder, mit section, einen Abschnitt davon samt den darunterliegenden Abschnitten als Markdown. url ist die Adresse der Seite, wie searchDocs sie liefert, ihre .md-Form oder nur ihr Pfad, mit oder ohne #fragment (ein Fragment benennt den Abschnitt, wenn section nicht angegeben ist). section ist eine Überschrift oder ein Anker der Seite oder ein Teil einer Überschrift.

Ein Abschnitt wird an einem Zeilenende innerhalb von 48 KiB abgeschnitten, mit truncated true; eine ganze Seite über 48 KiB antwortet mit ihrer Einleitung und ihrer Gliederung, mit truncated true. sections listet die Überschriften auf, die als Nächstes zu lesen sind (die der Seite oder die Unterüberschriften des Abschnitts selbst). Unbekannte Seiten und Abschnitte antworten mit 404 not_found.

Öffentlich, nie berechnet und auf dieselben 120 Anfragen pro Client-IP und Minute begrenzt wie searchDocs.