Skip to content

docs: translate public api docs to russian#120

Merged
forshev merged 1 commit intomainfrom
0-translate-docs-public-api
Sep 8, 2025
Merged

docs: translate public api docs to russian#120
forshev merged 1 commit intomainfrom
0-translate-docs-public-api

Conversation

@forshev
Copy link
Contributor

@forshev forshev commented Sep 8, 2025

Description

Translate public api docs to russian


  • I have read and followed all requirements in CONTRIBUTING.md;
  • I used LLM/AI assistance to make this pull request;

If you have used LLM/AI assistance please provide model name and full prompt:

Model: {{model-name}}
Prompt: {{prompt}}

Summary by CodeRabbit

  • Documentation
    • Added full Russian localization of the “Public API” documentation.
    • Translated all headings, sections, and explanatory text while preserving structure and meaning.
    • Localized labels for examples (requests, successful responses) and error descriptions.
    • Clarified Russian terminology for mapping, indexing, async search lifecycle, and proxy status.
    • Kept example data/code blocks unchanged; only surrounding descriptions translated.
    • No changes to API behavior or interfaces.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.86%. Comparing base (2d73a0a) to head (4f15796).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #120      +/-   ##
==========================================
+ Coverage   71.77%   71.86%   +0.08%     
==========================================
  Files         200      200              
  Lines       18078    18078              
==========================================
+ Hits        12976    12991      +15     
+ Misses       4379     4367      -12     
+ Partials      723      720       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai
Copy link

coderabbitai bot commented Sep 8, 2025

📝 Walkthrough

Walkthrough

The Russian documentation file docs/ru/10-public-api.md was fully localized from English to Russian, translating headings, prose, and labels while keeping structure, examples, and API semantics unchanged.

Changes

Cohort / File(s) Summary of changes
Documentation localization
docs/ru/10-public-api.md
Complete translation of the Public API document to Russian, including headings, descriptions, and labels; code blocks and examples retained structurally with translated annotations; no API behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 0-translate-docs-public-api

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/ru/10-public-api.md (1)

754-779: Fix inconsistent async-search request echo.

/FetchAsyncSearchResult shows a different query/time window than the earlier /StartAsyncSearch example. Align them to avoid confusion.

Apply this diff to the response sample’s embedded request:

-   "query": "message:peggy | fields level, message",
-   "from": "2025-08-01T05:20:00Z",
-   "to": "2025-09-01T05:21:00Z"
+   "query": "message:error | fields level, message",
+   "from": "2025-07-01T05:20:00Z",
+   "to": "2025-09-01T05:21:00Z"

Also applies to: 811-821

🧹 Nitpick comments (3)
docs/ru/10-public-api.md (3)

47-49: Add correct Content-Type for Bulk requests.

Bulk is NDJSON; add the header so copy-paste works with common clients.

- curl -X POST http://localhost:9002/_bulk -d '
+ curl -X POST http://localhost:9002/_bulk -H 'Content-Type: application/x-ndjson' -d '

181-183: Use standard Russian term for time series.

“таймсерии” is colloquial; prefer “временные ряды (тайм‑серии)”.

- полям документов ... (также известные как таймсерии).
+ полям документов ... (также известные как временные ряды/тайм‑серии).

205-205: Normalize NDJSON code fences.

“json lines” isn’t a recognized fence. Use ndjson (or keep json and note NDJSON in prose).

-```json lines
+```ndjson

Also applies to: 625-625, 721-721

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2d73a0a and 4f15796.

📒 Files selected for processing (1)
  • docs/ru/10-public-api.md (18 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: test
🔇 Additional comments (2)
docs/ru/10-public-api.md (2)

1-14: Solid localization overall.

Structure, anchors, and examples largely preserved; Russian reads naturally.


93-99: No action needed: consts.IngestorMaxInflightBulks (32) and linked docs are correct.

@forshev forshev merged commit 9ae52b9 into main Sep 8, 2025
11 checks passed
@forshev forshev deleted the 0-translate-docs-public-api branch September 8, 2025 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants