Module: PoliPage::Internal::Constants Private

Defined in:

lib/poli_page/internal/constants.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Internal constants. Convention-private; do not depend on these from outside the gem (no semver protection).

Constant Summary

PATH_RENDER =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

API paths (relative to the configured base URL).

"/v1/render"

PATH_RENDER_PREVIEW =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"/v1/render/preview"

PATH_DOCUMENTS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"/v1/documents"

DEFAULT_BASE_URL =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Defaults (in seconds where applicable — Ruby’s ‘Kernel#sleep`, `Net::HTTP#open_timeout`, etc. all use seconds).

"https://api.poli.page"

DEFAULT_MAX_RETRIES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

2

DEFAULT_RETRY_DELAY =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Node: 500 ms.

0.5

DEFAULT_TIMEOUT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Node: 60_000 ms.

60

RETRY_AFTER_CAP =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Node: 30_000 ms.

30

HEADER_AUTHORIZATION =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Header names (lowercase form — Net::HTTP normalises to lowercase on the way back; matches the Node ‘x-request-id` convention).

"Authorization"

HEADER_ACCEPT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"Accept"

HEADER_CONTENT_TYPE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"Content-Type"

HEADER_USER_AGENT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"User-Agent"

HEADER_IDEMPOTENCY_KEY =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"Idempotency-Key"

HEADER_REQUEST_ID =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"x-request-id"

HEADER_RETRY_AFTER =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"retry-after"

HEADER_DOCUMENT_PAGE_COUNT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Document-preview response header carrying the page count (mirrors Node ‘documents.ts:75-77`).

"x-document-page-count"