Skip to content

Comments

fix(api): apply styleguide-fixes#1864

Draft
aigerimu wants to merge 2 commits intomainfrom
apis-styleguide
Draft

fix(api): apply styleguide-fixes#1864
aigerimu wants to merge 2 commits intomainfrom
apis-styleguide

Conversation

@aigerimu
Copy link
Contributor

closes #1843

@aigerimu aigerimu marked this pull request as draft February 18, 2026 08:39
@github-actions
Copy link

To fix the formatting issues:

  1. Install necessary dependencises: npm ci
  2. Then, run this command:
    npm run fmt:some -- ecosystem/api/toncenter/v2-authentication.mdx ecosystem/api/toncenter/v2/overview.mdx ecosystem/api/toncenter/v3-authentication.mdx ecosystem/api/toncenter/v3/overview.mdx

Alternatively, a maintainer can comment /fmt in this PR to auto-apply fixes in a new commit from the bot.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thanks for the updates to ecosystem/api/toncenter: I’ve left a couple of suggestions to restore consistent table formatting, so please apply the inline suggestions.

| `403` | `Network not allowed` | The key was issued for a different network (e.g., testnet key on mainnet). Use a key matching the target network. |
| `429` | `Ratelimit exceeded` | Too many requests. Back off and retry, or use an API key for higher limits. |
| Status | Error | Meaning |
|--------|--------------------------|------------------------------------------------------------------------------------------------------------------|

Choose a reason for hiding this comment

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

[HIGH] Status column no longer right-aligned in v2 API key error table

In the v2 authentication documentation, the separator row for the Status column has been changed from a right-aligned numeric column definition (-----:) to a plain left-aligned definition (--------). This causes the HTTP status codes in the first column to be left-aligned, which regresses from the previous, more readable numeric alignment. The style guide requires numeric columns in tables to be right-aligned for easier scanning and comparison (see https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L890-L900 for the table alignment rule). The issue is introduced directly on the separator row at line 89, which is part of the PR diff.

Suggested change
|--------|--------------------------|------------------------------------------------------------------------------------------------------------------|
| -----: | ------------------------ | ----------------------------------------------------------------------------------------------------------------- |

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

| `401` | `API key does not exist` | The provided key is invalid. Check for typos or generate a new key. |
| `403` | `Network not allowed` | The key was issued for a different network (e.g., testnet key on mainnet). Use a key matching the target network. |
| `429` | `Ratelimit exceeded` | Too many requests. Back off and retry, or use an API key for higher limits. |
|--------|--------------------------|-------------------------------------------------------------------------------------------------------------------|

Choose a reason for hiding this comment

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

[HIGH] Status column no longer right-aligned in v3 API key error table

In the v3 authentication documentation, the separator row for the Status column has also been changed from a right-aligned numeric column definition to a plain left-aligned one. As in the v2 document, this change left-aligns the HTTP status codes, reducing readability and violating the numeric-column alignment rule from the style guide. The regression is localized to the separator row at line 58, which lies within the PR diff and directly controls how the column is rendered. Keeping numeric status codes right-aligned is important for quickly scanning and comparing error codes.

Suggested change
|--------|--------------------------|-------------------------------------------------------------------------------------------------------------------|
| -----: | ------------------------ | ----------------------------------------------------------------------------------------------------------------- |

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

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.

[Ecosystem > APIs] Put pages in agreement with styleguide

1 participant