API de Serviço e capacidades

Pronto para servir. Um host em drenagem responde 421 server_draining com Retry-After: 1. Uma falha em dependência necessária responde 500 not_ready com Retry-After. Um esquema de banco de dados ativo que não satisfaz esta versão (um índice desejado ausente ou diferente por mais de dois minutos) responde 500 schema_incompatible sem Retry-After: não se resolve esperando.

Pesquisa na documentação oficial do screenRIG, nas páginas de screenrig.ai/docs, nos tipos de problema, nos preços e nas demais páginas para clientes, e retorna as seções que melhor correspondem, da mais relevante para a menos relevante, no máximo limit (8 por padrão). Público: nenhuma credencial é necessária e a chamada nunca é cobrada.

A url de um resultado é a sua página (com o fragmento da seção quando a página nomeia um), section é o título e snippet mostra o texto em torno da correspondência; leia a página ou a seção com getDocsPage. Limitado a 120 solicitações por IP de cliente por minuto (IPv6 agrupado por /64).

O corpus é recarregado a cada 15 minutos; antes do primeiro carregamento, a rota responde 500 not_ready com Retry-After.

Retorna uma página da documentação oficial ou, com section, uma única seção dela com as subseções, em Markdown. url é o endereço da página como searchDocs o retorna, sua forma .md ou só o caminho, com ou sem #fragment (um fragmento nomeia a seção quando section não é informado). section é um título ou uma âncora da página, ou parte de um título.

Uma seção é cortada em um fim de linha dentro de 48 KiB, com truncated true; uma página inteira com mais de 48 KiB responde com sua introdução e sua estrutura de tópicos, com truncated true. sections lista os títulos a ler em seguida (os da página ou os subtítulos da própria seção). Páginas e seções desconhecidas respondem 404 not_found.

Público, nunca cobrado e limitado às mesmas 120 solicitações por IP de cliente por minuto que searchDocs.